org.eclipse.stardust.engine.api.query
Enum HistoricalStatesPolicy

java.lang.Object
  extended by java.lang.Enum<HistoricalStatesPolicy>
      extended by org.eclipse.stardust.engine.api.query.HistoricalStatesPolicy
All Implemented Interfaces:
Serializable, Comparable<HistoricalStatesPolicy>, EvaluationPolicy

public enum HistoricalStatesPolicy
extends Enum<HistoricalStatesPolicy>
implements EvaluationPolicy

Evaluation policy for specifying retrieval of historical states.

Version:
$Revision$
Author:
born

Enum Constant Summary
NO_HIST_STATES
          Retrieve no historical states.
WITH_HIST_STATES
          Retrieve all historical states.
WITH_LAST_HIST_STATE
          Retrieve the last historical state only.
WITH_LAST_USER_PERFORMER
          Retrieve the last user performer from historical states.
 
Field Summary
static String PRP_PROPVIDE_HIST_STATES
           
 
Method Summary
 boolean includeHistStates()
          Determines whether this policy can be used in order to retrieve historical states.
 boolean isCompleteHistory()
          Determines whether this policy can be used in order to retrieve complete states history.
static HistoricalStatesPolicy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static HistoricalStatesPolicy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NO_HIST_STATES

public static final HistoricalStatesPolicy NO_HIST_STATES
Retrieve no historical states. This is the default.


WITH_LAST_HIST_STATE

public static final HistoricalStatesPolicy WITH_LAST_HIST_STATE
Retrieve the last historical state only.


WITH_LAST_USER_PERFORMER

public static final HistoricalStatesPolicy WITH_LAST_USER_PERFORMER
Retrieve the last user performer from historical states.


WITH_HIST_STATES

public static final HistoricalStatesPolicy WITH_HIST_STATES
Retrieve all historical states.

Field Detail

PRP_PROPVIDE_HIST_STATES

public static final String PRP_PROPVIDE_HIST_STATES
Method Detail

values

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

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

valueOf

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

includeHistStates

public boolean includeHistStates()
Determines whether this policy can be used in order to retrieve historical states.

Returns:
true if this policy can be used in order to retrieve historical states. Otherwise false.

isCompleteHistory

public boolean isCompleteHistory()
Determines whether this policy can be used in order to retrieve complete states history.

Returns:
true if this policy can be used in order to retrieve complete states history. Otherwise false.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.