wt.vc.config
Class LifeCycleConfigSpec

java.lang.Object
  wt.vc.config.LifeCycleConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable

public class LifeCycleConfigSpec

extends Object

implements ConfigSpec, ObjectMappable, Externalizable

The LifeCycleConfigSpec can be applied to LifeCycleManaged elements to filter them based on life cycle state. Only those elements at the specified life cycle state will be returned.

Use the newLifeCycleConfigSpec static factory method(s), not the LifeCycleConfigSpec constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

LifeCycleManaged, Serialized Form

Field Summary

static String

LIFE_CYCLE_STATE Label for the attribute; The state to filter elements on.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "lifecyclestate = getLifeCycleState()" to the QuerySpec, indicating that all elements must be at the particular state.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
protected void	initialize(State lifeCycleState) Supports initialization, following construction of an instance.
static LifeCycleConfigSpec	newLifeCycleConfigSpec(State lifeCycleState) Constructs a new LifeCycleConfigSpec using the specified state.
QueryResult	process(QueryResult results) Returns a clone of the results.
void	setLifeCycleState(State a_LifeCycleState) Sets the value of the attribute: LIFE_CYCLE_STATE.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LIFE_CYCLE_STATE

public static final String LIFE_CYCLE_STATE

Label for the attribute; The state to filter elements on.

Supported API: true

See Also:

Constant Field Values

Method Detail

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE. The state to filter elements on.

Supported API: true

Returns:

State

setLifeCycleState

public void setLifeCycleState(State a_LifeCycleState)
                       throws WTPropertyVetoException

Sets the value of the attribute: LIFE_CYCLE_STATE. The state to filter elements on.

Supported API: true

Parameters:

a_LifeCycleState -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a "lifecyclestate = getLifeCycleState()" to the QuerySpec, indicating that all elements must be at the particular state.

Supported API: true

Specified by:

appendSearchCriteria in interface ConfigSpec

Parameters:

querySpec - A QuerySpec with a target class that is Iterated.

Returns:

QuerySpec

Throws:

WTException

QueryException

See Also:

QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException

Returns a clone of the results. No processing is done: it is expected that the results have already been pre-filtered by the search.

Supported API: true

Specified by:

process in interface ConfigSpec

Parameters:

results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.

Returns:

QueryResult

Throws:

WTException

See Also:

QueryResult, Iterated

newLifeCycleConfigSpec

public static LifeCycleConfigSpec newLifeCycleConfigSpec(State lifeCycleState)
                                                  throws WTPropertyVetoException

Constructs a new LifeCycleConfigSpec using the specified state.

Supported API: true

Parameters:

lifeCycleState -

Returns:

LifeCycleConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(State lifeCycleState)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

lifeCycleState -

Throws:

WTPropertyVetoException