wt.vc.config
Class IteratedFolderedConfigSpec

java.lang.Object
  wt.vc.config.IteratedFolderedConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class IteratedFolderedConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, Externalizable

The IteratedFolderedConfigSpec can be used to filter IteratedFoldered elements based on folder location. Only those elements in the particular folder or sub-folder will be returned by this ConfigSpec.

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

IteratedFoldered, Serialized Form

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "folder = getFolder() OR folder = subFolder OR ..." to the QuerySpec.
QueryResult	process(QueryResult results) Returns a clone of the results.

Methods inherited from class java.lang.Object

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

Method Detail

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a "folder = getFolder() OR folder = subFolder OR ..." to the QuerySpec.

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