Package org.kuali.rice.kew.api.document.search

Enum Class RouteNodeLookupLogic

java.lang.Object

java.lang.Enum<RouteNodeLookupLogic>

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

All Implemented Interfaces:

Serializable, Comparable<RouteNodeLookupLogic>, Constable

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)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
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

Modifier and Type	Method	Description
static RouteNodeLookupLogic	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RouteNodeLookupLogic[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static RouteNodeLookupLogic[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RouteNodeLookupLogic valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null