com.endeca.infront.navigation.event
Enum RequestType

java.lang.Object
  extended by java.lang.Enum<RequestType>
      extended by com.endeca.infront.navigation.event.RequestType
All Implemented Interfaces:
Serializable, Comparable<RequestType>

public enum RequestType
extends Enum<RequestType>

Navigation request types


Enum Constant Summary
NAVIGATION_ONLY
          Navigation only request
OTHER
          Unknown request
RECORD
          Record detail request
ROOT
          Root request (such as when the site is first hit)
SEARCH_ONLY
          Search only request
SEARCH_THEN_NAVIGATE
          Search followed by navigation request
 
Method Summary
static RequestType deriveRequestType(NavigationState navigationState)
          Attempt to infer the type of page request from a given navigation state.
 String toString()
           
static RequestType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RequestType[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SEARCH_ONLY

public static final RequestType SEARCH_ONLY
Search only request


NAVIGATION_ONLY

public static final RequestType NAVIGATION_ONLY
Navigation only request


SEARCH_THEN_NAVIGATE

public static final RequestType SEARCH_THEN_NAVIGATE
Search followed by navigation request


ROOT

public static final RequestType ROOT
Root request (such as when the site is first hit)


RECORD

public static final RequestType RECORD
Record detail request


OTHER

public static final RequestType OTHER
Unknown request

Method Detail

values

public static RequestType[] 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 (RequestType c : RequestType.values())
    System.out.println(c);

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

valueOf

public static RequestType 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

toString

public String toString()
Overrides:
toString in class Enum<RequestType>
Returns:
a string representation of the request type

deriveRequestType

public static RequestType deriveRequestType(NavigationState navigationState)
Attempt to infer the type of page request from a given navigation state.

Parameters:
navigationState - the navigation state
Returns:
the inferred request type


Copyright © 2012, Oracle and/or its affiliates. All rights reserved.