Package wt.vc.config

Class InUseConfigSpec

java.lang.Object

wt.vc.config._InUseConfigSpec

wt.vc.config.InUseConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec

@GenAsObjectMappable(interfaces=ConfigSpec.class,
                     versions=4282402626032281481L,
                     properties=@GeneratedProperty(name="inUseByCurrentPrincipalIncluded",type=boolean.class,initialValue="true",supportedAPI=PUBLIC,javaDoc="If set to true, include those elements the current principal has \'in use\'."))
public class InUseConfigSpec
extends _InUseConfigSpec

The InUseConfigSpec uses the InUseDelegate mechanism to filter out elements that are in use by other principals. If 'inUseByCurrentPrincipalIncluded' is set to true, those elements in use by the current principal will be returned, otherwise they will not.

Use the newInUseConfigSpec static factory method(s), not the InUseConfigSpec 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

Fields inherited from class wt.vc.config._InUseConfigSpec

IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED

Method Summary

Modifier and Type	Method	Description
QuerySpec	appendSearchCriteria(QuerySpec querySpec)	Returns a clone of the passed-in QuerySpec.
QueryResult	process(QueryResult results)	Returns a sub-set of the QueryResult, containing only those versions that are not 'in use', except possibly by the current principal.

Methods inherited from class wt.vc.config._InUseConfigSpec

isInUseByCurrentPrincipalIncluded, setInUseByCurrentPrincipalIncluded

Methods inherited from class java.lang.Object

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

Method Details

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
QueryException

Returns a clone of the passed-in QuerySpec.

Supported API: true

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 sub-set of the QueryResult, containing only those versions that are not 'in use', except possibly by the current principal.

Supported API: true

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