com.ptc.windchill.mpml.processplan
Class MPMProcessPlanStandardConfigSpec

java.lang.Object
  com.ptc.windchill.mpml.processplan.MPMProcessPlanStandardConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class MPMProcessPlanStandardConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, Externalizable

A ConfigSpec used to filter MPMProcessPlan, MPMSequence and MPMOperation 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 process plans, sequences and operations at that particular state are eligible.

While process plans, sequences and operations 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 newMPMProcessPlanStandardConfigSpec static factory method(s), not the MPMProcessPlanStandardConfigSpec 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	LIFE_CYCLE_STATE Label for the attribute.
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.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(State lifeCycleState) Supports initialization, following construction of an instance.
boolean	isWorkingIncluded() Gets the value of the attribute: WORKING_INCLUDED.
static MPMProcessPlanStandardConfigSpec	newMPMProcessPlanStandardConfigSpec() Construct a default MPMProcessPlanStandardConfigSpec.
static MPMProcessPlanStandardConfigSpec	newMPMProcessPlanStandardConfigSpec(State lifeCycleState) Construct a MPMProcessPlanStandardConfigSpec, setting the lifeCycleState to the passed-in values.
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setLifeCycleState(State a_LifeCycleState) Sets the value of the attribute: LIFE_CYCLE_STATE.
void	setWorkingIncluded(boolean a_WorkingIncluded) Sets the value of the attribute: WORKING_INCLUDED.

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.

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

Method Detail

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE.

Supported API: true

Returns:

State

setLifeCycleState

public void setLifeCycleState(State a_LifeCycleState)

Sets the value of the attribute: LIFE_CYCLE_STATE.

Supported API: true

Parameters:

a_LifeCycleState -

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

setWorkingIncluded

public void setWorkingIncluded(boolean a_WorkingIncluded)

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

Supported API: true

Parameters:

a_WorkingIncluded -

newMPMProcessPlanStandardConfigSpec

public static MPMProcessPlanStandardConfigSpec newMPMProcessPlanStandardConfigSpec()
                                                                            throws WTException

Construct a default MPMProcessPlanStandardConfigSpec.

Supported API: true

Returns:

MPMProcessPlanStandardConfigSpec

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

newMPMProcessPlanStandardConfigSpec

public static MPMProcessPlanStandardConfigSpec newMPMProcessPlanStandardConfigSpec(State lifeCycleState)
                                                                            throws WTException

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

Supported API: true

Parameters:

lifeCycleState -

Returns:

MPMProcessPlanStandardConfigSpec

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

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