wt.doc
Class WTDocumentStandardConfigSpec

java.lang.Object
  wt.doc.WTDocumentStandardConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class WTDocumentStandardConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, Externalizable

A ConfigSpec used to filter WTDocuments based on their life cycle state and work in progress state.

This ConfigSpec considers only versions (latest iterations), and returns at most one version per master (the latest eligible version).

If the State value is set, only those documents at that particular state are eligible.

While documents owned by any user other than the current principal are never eligible, the user's own versions are only eligible when workingIncluded is set to true (the default).

Use the newWTDocumentStandardConfigSpec static factory method(s), not the WTDocumentStandardConfigSpec 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:

Serialized Form

Field Summary

static String	IN_USE Label for the attribute.
static String	LIFE_CYCLE Label for the attribute.
static String	LIFE_CYCLE_STATE Label for the attribute; If set, ONLY those WTDocuments at this particular state are returned.
static String	WORKING_INCLUDED Label for the attribute; If true, include any working copies I may have.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec.
InUseConfigSpec	getInUse() Gets the object for the association that plays role: IN_USE.
LifeCycleConfigSpec	getLifeCycle() Gets the object for the association that plays role: LIFE_CYCLE.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(boolean a_workingIncluded) Supports initialization, following construction of an instance.
protected void	initialize(State lifeCycleState) Supports initialization, following construction of an instance.
protected void	initialize(State lifeCycleState, boolean a_workingIncluded) Supports initialization, following construction of an instance.
boolean	isWorkingIncluded() Gets the value of the attribute: WORKING_INCLUDED.
static WTDocumentStandardConfigSpec	newWTDocumentStandardConfigSpec() Construct a default WTDocumentStandardConfigSpec.
static WTDocumentStandardConfigSpec	newWTDocumentStandardConfigSpec(boolean a_workingIncluded) Construct a WTDocumentStandardConfigSpec, setting the workingIncluded to the passed-in values.
static WTDocumentStandardConfigSpec	newWTDocumentStandardConfigSpec(State lifeCycleState) Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState to the passed-in values.
static WTDocumentStandardConfigSpec	newWTDocumentStandardConfigSpec(State lifeCycleState, boolean a_workingIncluded) Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState and the workingIncluded to the passed-in values.
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setInUse(InUseConfigSpec a_InUse) Sets the object for the association that plays role: IN_USE.
void	setLifeCycle(LifeCycleConfigSpec a_LifeCycle) Sets the object for the association that plays role: LIFE_CYCLE.

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; If set, ONLY those WTDocuments at this particular state are returned.

Supported API: true

See Also:

Constant Field Values

WORKING_INCLUDED

public static final String WORKING_INCLUDED

Label for the attribute; If true, include any working copies I may have.

Supported API: true

See Also:

Constant Field Values

IN_USE

public static final String IN_USE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

LIFE_CYCLE

public static final String LIFE_CYCLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE. If set, ONLY those WTDocuments at this particular state are returned.

Supported API: true

Returns:

State

isWorkingIncluded

public boolean isWorkingIncluded()

Gets the value of the attribute: WORKING_INCLUDED. If true, include any working copies I may have.

Supported API: true

Returns:

boolean

getInUse

public InUseConfigSpec getInUse()

Gets the object for the association that plays role: IN_USE.

Supported API: true

Returns:

InUseConfigSpec

setInUse

public void setInUse(InUseConfigSpec a_InUse)

Sets the object for the association that plays role: IN_USE.

Supported API: true

Parameters:

a_InUse -

getLifeCycle

public LifeCycleConfigSpec getLifeCycle()

Gets the object for the association that plays role: LIFE_CYCLE.

Supported API: true

Returns:

LifeCycleConfigSpec

setLifeCycle

public void setLifeCycle(LifeCycleConfigSpec a_LifeCycle)

Sets the object for the association that plays role: LIFE_CYCLE.

Supported API: true

Parameters:

a_LifeCycle -

newWTDocumentStandardConfigSpec

public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec()
                                                                    throws WTException

Construct a default WTDocumentStandardConfigSpec.

Supported API: true

Returns:

WTDocumentStandardConfigSpec

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: true

Throws:

WTException

newWTDocumentStandardConfigSpec

public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(State lifeCycleState)
                                                                    throws WTException

Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState to the passed-in values.

Supported API: true

Parameters:

lifeCycleState -

Returns:

WTDocumentStandardConfigSpec

Throws:

WTException

initialize

protected void initialize(State lifeCycleState)
                   throws WTException

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

Supported API: true

Parameters:

lifeCycleState -

Throws:

WTException

newWTDocumentStandardConfigSpec

public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(State lifeCycleState,
                                                                           boolean a_workingIncluded)
                                                                    throws WTException

Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState and the workingIncluded to the passed-in values.

Supported API: true

Parameters:

lifeCycleState -

a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.

Returns:

WTDocumentStandardConfigSpec

Throws:

WTException

initialize

protected void initialize(State lifeCycleState,
                          boolean a_workingIncluded)
                   throws WTException

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

Supported API: true

Parameters:

lifeCycleState -

a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.

Throws:

WTException

newWTDocumentStandardConfigSpec

public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(boolean a_workingIncluded)
                                                                    throws WTException

Construct a WTDocumentStandardConfigSpec, setting the workingIncluded to the passed-in values.

Supported API: true

Parameters:

a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.

Returns:

WTDocumentStandardConfigSpec

Throws:

WTException

initialize

protected void initialize(boolean a_workingIncluded)
                   throws WTException

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

Supported API: true

Parameters:

a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.

Throws:

WTException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec. Appending additional classes to the QuerySpec is allowed (for join purposes), but those that are marked as selectable will be trimmed by "filteredIterationsOf" prior to it calling the "process" API.

The QueryResult returned should be a copy of the passed in one (taking advantage of side-effects is not encouraged).

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

Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

The QueryResult returned should be a copy of the passed-in QueryResult (side-effects should be avoided).

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