wt.epm.workspaces
Class EPMAsStoredConfigSpec

java.lang.Object
  wt.epm.workspaces.EPMAsStoredConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, Evolvable, ConfigSpec

public class EPMAsStoredConfigSpec
extends Object
implements ConfigSpec, Evolvable, Externalizable

The EPMAsStoredConfigSpec can be applied to Baselineables to filter those elements based on membership in an EPMAsStoredConfig. Substitution options are read from preferences and result in the following order of substitution rules when the iteration is not found in the configuration: 1) If substitutes are allowed, do not filter out links marked as substitutes. 2) If no iteration is found, use latest.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends to the QuerySpec based on the substitution rules to be followed.
static EPMAsStoredConfigSpec	newEPMAsStoredConfigSpec(wt.epm.workspaces.EPMAsStoredConfig configuration) Factory method to create a new EPMAsStoredConfigSpec using the specified EPMAsStoredConfig.
static EPMAsStoredConfigSpec	newEPMAsStoredConfigSpec(EPMDocument seed) Factory method to create a new EPMAsStoredConfigSpec given a seed object.
static EPMAsStoredConfigSpec	newEPMAsStoredConfigSpec(List seeds) Factory method to create a new EPMAsStoredConfigSpec given a list of seed objects.
QueryResult	process(QueryResult results) Returns a clone of the results.

Methods inherited from class java.lang.Object

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

Method Detail

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends to the QuerySpec based on the substitution rules to be followed.

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

newEPMAsStoredConfigSpec

public static EPMAsStoredConfigSpec newEPMAsStoredConfigSpec(EPMDocument seed)
                                                      throws WTPropertyVetoException,
                                                             WTException

Factory method to create a new EPMAsStoredConfigSpec given a seed object. Null is returned if the seed is not an owner of an EPMAsStoredConfig.

Supported API: true

Parameters:

seed - Use the EPMAsStoredConfig to which the seed has an owner association.

Returns:

EPMAsStoredConfigSpec

Throws:

WTPropertyVetoException

WTException

newEPMAsStoredConfigSpec

public static EPMAsStoredConfigSpec newEPMAsStoredConfigSpec(wt.epm.workspaces.EPMAsStoredConfig configuration)
                                                      throws WTPropertyVetoException,
                                                             WTException

Factory method to create a new EPMAsStoredConfigSpec using the specified EPMAsStoredConfig.

Supported API: true

Parameters:

configuration -

Returns:

EPMAsStoredConfigSpec

Throws:

WTPropertyVetoException

WTException

newEPMAsStoredConfigSpec

public static EPMAsStoredConfigSpec newEPMAsStoredConfigSpec(List seeds)
                                                      throws WTPropertyVetoException,
                                                             WTException

Factory method to create a new EPMAsStoredConfigSpec given a list of seed objects.

Supported API: true

Parameters:

seeds - Use the EPMAsStoredConfig to which the seed has an owner association.

Returns:

EPMAsStoredConfigSpec

Throws:

WTPropertyVetoException

WTException