wt.vc.config
Class InUseConfigSpec

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

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable

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

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
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'.
private boolean	inUseByCurrentPrincipalIncluded
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

InUseConfigSpec()

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Returns a clone of the passed-in QuerySpec.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isInUseByCurrentPrincipalIncluded() Gets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED.
static InUseConfigSpec	newInUseConfigSpec() Default factory for the class.
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(InUseConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setInUseByCurrentPrincipalIncluded(boolean a_InUseByCurrentPrincipalIncluded) Sets the value of the attribute: IN_USE_BY_CURRENT_PRINCIPAL_INCLUDED.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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

inUseByCurrentPrincipalIncluded

private boolean inUseByCurrentPrincipalIncluded

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

InUseConfigSpec

public InUseConfigSpec()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(InUseConfigSpec thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

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

newInUseConfigSpec

public static InUseConfigSpec newInUseConfigSpec()
                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

InUseConfigSpec

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException