org.bonitasoft.engine.bpm.process

Enum ProcessInstanceCriterion

java.lang.Object

java.lang.Enum<ProcessInstanceCriterion>

org.bonitasoft.engine.bpm.process.ProcessInstanceCriterion

All Implemented Interfaces:

Serializable, Comparable<ProcessInstanceCriterion>

public enum ProcessInstanceCriterion
extends Enum<ProcessInstanceCriterion>

Sort criterion used to specify the sort order of the ProcessInstance.
Used by ProcessRuntimeAPI methods like ProcessRuntimeAPI.getProcessInstances(int, int, ProcessInstanceCriterion) to indicate in what order we should return the list of the results.

Since:

6.0.0

Version:

6.3.5

Author:

Emmanuel Duchastenier, Yanyan Liu, Celine Souchet

See Also:

ProcessRuntimeAPI

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVE_DATE_ASC Archive date ascending order
ARCHIVE_DATE_DESC Archive date descending order
CREATION_DATE_ASC Creation date ascending order
CREATION_DATE_DESC Creation date descending order
DEFAULT Default sort criterion
LAST_UPDATE_ASC Last update ascending order
LAST_UPDATE_DESC Last update descending order
NAME_ASC Process instance name ascending order
NAME_DESC Process instance name descending order
STATE_ASC Process State ascending order
STATE_DESC Process State descending order

Method Summary

Modifier and Type	Method and Description
static ProcessInstanceCriterion	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProcessInstanceCriterion[]	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

STATE_ASC

public static final ProcessInstanceCriterion STATE_ASC

Process State ascending order

STATE_DESC

public static final ProcessInstanceCriterion STATE_DESC

Process State descending order

NAME_ASC

public static final ProcessInstanceCriterion NAME_ASC

Process instance name ascending order

NAME_DESC

public static final ProcessInstanceCriterion NAME_DESC

Process instance name descending order

CREATION_DATE_ASC

public static final ProcessInstanceCriterion CREATION_DATE_ASC

Creation date ascending order

CREATION_DATE_DESC

public static final ProcessInstanceCriterion CREATION_DATE_DESC

Creation date descending order

LAST_UPDATE_ASC

public static final ProcessInstanceCriterion LAST_UPDATE_ASC

Last update ascending order

LAST_UPDATE_DESC

public static final ProcessInstanceCriterion LAST_UPDATE_DESC

Last update descending order

ARCHIVE_DATE_ASC

public static final ProcessInstanceCriterion ARCHIVE_DATE_ASC

Archive date ascending order

ARCHIVE_DATE_DESC

public static final ProcessInstanceCriterion ARCHIVE_DATE_DESC

Archive date descending order

DEFAULT

public static final ProcessInstanceCriterion DEFAULT

Default sort criterion

Method Detail

values

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

Returns:

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

valueOf

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