wt.epm.workspaces
Class WorkspaceConfigSpec

java.lang.Object
  wt.epm.workspaces.WorkspaceConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, ConfigSpec

public class WorkspaceConfigSpec
extends Object
implements ConfigSpec, Externalizable

This config spec filters objects based on its checkout info and its workspace checkpoint. Only objects that are either not working or working and in its workspace checkpoint are returned.

Supported API: true

Extendable: false

See Also:

Serialized Form

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.
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

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 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