com.sap.portal.search.service

Enum SearchProviderConstants.SearchProviderNavigationType

java.lang.Object
  extended by java.lang.Enum<SearchProviderConstants.SearchProviderNavigationType>
      extended by com.sap.portal.search.service.SearchProviderConstants.SearchProviderNavigationType
All Implemented Interfaces:
Serializable, Comparable<SearchProviderConstants.SearchProviderNavigationType>
Enclosing class:
SearchProviderConstants

public static enum SearchProviderConstants.SearchProviderNavigationType
extends Enum<SearchProviderConstants.SearchProviderNavigationType>

An enumeration that defines the types of navigation to the search results window INTERNAL - internal portal EPCM.doNavigate navigation EXTERNAL - external window.open navigation


Enum Constant Summary
EXTERNAL
          External navigation (window.open)
INTERNAL
          Internal portal navigation (EPCM.doNavigate)
INTERNAL_POST
          Internal portal navigation (EPCM.doNavigate) where the parameters are passed in the POST body.
 
Method Summary
static SearchProviderConstants.SearchProviderNavigationType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SearchProviderConstants.SearchProviderNavigationType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INTERNAL

public static final SearchProviderConstants.SearchProviderNavigationType INTERNAL
Internal portal navigation (EPCM.doNavigate)


INTERNAL_POST

public static final SearchProviderConstants.SearchProviderNavigationType INTERNAL_POST
Internal portal navigation (EPCM.doNavigate) where the parameters are passed in the POST body.

When using this option, pass the template in the following format: "COMPONENT_PATH?parameterAKey=parameterAValue&ParameterBKey=parameterBValue&..."


EXTERNAL

public static final SearchProviderConstants.SearchProviderNavigationType EXTERNAL
External navigation (window.open)

Method Detail

values

public static SearchProviderConstants.SearchProviderNavigationType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SearchProviderConstants.SearchProviderNavigationType c : SearchProviderConstants.SearchProviderNavigationType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchProviderConstants.SearchProviderNavigationType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/navigation/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice