org.kuali.rice.kew.api.document.search
Enum RouteNodeLookupLogic

java.lang.Object
  extended by java.lang.Enum<RouteNodeLookupLogic>
      extended by org.kuali.rice.kew.api.document.search.RouteNodeLookupLogic
All Implemented Interfaces:
Serializable, Comparable<RouteNodeLookupLogic>

public enum RouteNodeLookupLogic
extends Enum<RouteNodeLookupLogic>

Defines flags that can be used during document search to indicate what relation the route node name being searched on should have to the current route node of the documents being searched.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary
AFTER
          Indicates that the document should currently be somewhere after the specified route node in it's route path.
BEFORE
          Indicates that the document should currently be somewhere before the specified route node in it's route path.
EXACTLY
          Indicates that the document should be exactly at the specified route node in it's route path.
 
Method Summary
static RouteNodeLookupLogic valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RouteNodeLookupLogic[] 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

EXACTLY

public static final RouteNodeLookupLogic EXACTLY
Indicates that the document should be exactly at the specified route node in it's route path.


BEFORE

public static final RouteNodeLookupLogic BEFORE
Indicates that the document should currently be somewhere before the specified route node in it's route path.


AFTER

public static final RouteNodeLookupLogic AFTER
Indicates that the document should currently be somewhere after the specified route node in it's route path.

Method Detail

values

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

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

valueOf

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


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.