wt.vc.config
Class InUseConfigSpec

java.lang.Object
  wt.vc.config.InUseConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class InUseConfigSpec
extends Object
implements ConfigSpec, ObjectMappable, Externalizable

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

static String

IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED Label for the attribute; If set to true, include those elements the current principal has 'in use'.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Returns a clone of the passed-in QuerySpec.
boolean	isInUseByCurrentPrincipalIncluded() Gets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED.
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.
void	setInUseByCurrentPrincipalIncluded(boolean a_InUseByCurrentPrincipalIncluded) Sets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED.

Methods inherited from class java.lang.Object

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

Field Detail

IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED

public static final String IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED

Label for the attribute; If set to true, include those elements the current principal has 'in use'.

Supported API: true

See Also:

Constant Field Values

Method Detail

isInUseByCurrentPrincipalIncluded

public boolean isInUseByCurrentPrincipalIncluded()

Gets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED. If set to true, include those elements the current principal has 'in use'.

Supported API: true

Returns:

boolean

setInUseByCurrentPrincipalIncluded

public void setInUseByCurrentPrincipalIncluded(boolean a_InUseByCurrentPrincipalIncluded)
                                        throws WTPropertyVetoException

Sets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED. If set to true, include those elements the current principal has 'in use'.

Supported API: true

Parameters:

a_InUseByCurrentPrincipalIncluded -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

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

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