wt.part
Class WTPartStandardConfigSpec

java.lang.Object
  wt.part.WTPartStandardConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable

Direct Known Subclasses:

ESIDefaultConfigSpec

public class WTPartStandardConfigSpec

extends Object

implements ConfigSpec, ObjectMappable, Externalizable

A ConfigSpec used to filter WTParts based on their life cycle state, membership in a view, and work in progress state.

This ConfigSpec considers only versions (latest iterations), and returns at most one version per master (the latest eligible version).

If the State value is set, only those parts at that particular state are eligible.

If the view is set, only those parts in the view and any of its parents (and any view-independent versions) are eligible, although the parts assigned the view are taken over any assigned to parent views, unless there is none assigned to the view, in which case the parents are checked until there's at least one version assigned to a parent view. If the view is not set, only view-independent versions are eligible.

While parts owned by any user other than the current principal are never eligible, the user's own versions are only eligible when workingIncluded is set to true (the default).

Use the newWTPartStandardConfigSpec static factory method(s), not the WTPartStandardConfigSpec 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	LIFE_CYCLE_STATE Label for the attribute; If set, ONLY those WTParts at this particular state are returned.
private static int	LIFE_CYCLE_STATE_UPPER_LIMIT
private State	lifeCycleState
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	VIEW Label for the attribute; If set, only those objects assigned to the view or view-independent are returned.
private ViewReference	viewRef
static String	WORKING_INCLUDED Label for the attribute; If true, include any working copies I may have.
private boolean	workingIncluded

Constructor Summary

WTPartStandardConfigSpec()

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.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
View	getView() Gets the value of the attribute: VIEW.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(View view, State lifeCycleState) Supports initialization, following construction of an instance.
boolean	isWorkingIncluded() Gets the value of the attribute: WORKING_INCLUDED.
static WTPartStandardConfigSpec	newWTPartStandardConfigSpec() Construct a default WTPartStandardConfigSpec.
static WTPartStandardConfigSpec	newWTPartStandardConfigSpec(View view, State lifeCycleState) Construct a WTPartStandardConfigSpec, setting the view and lifeCycleState to the passed-in values.
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
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(WTPartStandardConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setLifeCycleState(State a_LifeCycleState) Sets the value of the attribute: LIFE_CYCLE_STATE.
void	setView(View a_View) Sets the value of the attribute: VIEW.
void	setWorkingIncluded(boolean a_WorkingIncluded) Sets the value of the attribute: WORKING_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

LIFE_CYCLE_STATE

public static final String LIFE_CYCLE_STATE

Label for the attribute; If set, ONLY those WTParts at this particular state are returned.

Supported API: true

See Also:

Constant Field Values

LIFE_CYCLE_STATE_UPPER_LIMIT

private static int LIFE_CYCLE_STATE_UPPER_LIMIT

lifeCycleState

private State lifeCycleState

WORKING_INCLUDED

public static final String WORKING_INCLUDED

Label for the attribute; If true, include any working copies I may have.

Supported API: true

See Also:

Constant Field Values

workingIncluded

private boolean workingIncluded

VIEW

public static final String VIEW

Label for the attribute; If set, only those objects assigned to the view or view-independent are returned. If no WTParts match the view, the parent is checked (until there is either at least one match or no parent). If not set, only view-independent parts are returned.

Supported API: true

See Also:

Constant Field Values

viewRef

private ViewReference viewRef

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

WTPartStandardConfigSpec

public WTPartStandardConfigSpec()

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

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE. If set, ONLY those WTParts at this particular state are returned.

Supported API: true

Returns:

State

setLifeCycleState

public void setLifeCycleState(State a_LifeCycleState)

Sets the value of the attribute: LIFE_CYCLE_STATE. If set, ONLY those WTParts at this particular state are returned.

Supported API: true

Parameters:

a_LifeCycleState -

isWorkingIncluded

public boolean isWorkingIncluded()

Gets the value of the attribute: WORKING_INCLUDED. If true, include any working copies I may have.

Supported API: true

Returns:

boolean

setWorkingIncluded

public void setWorkingIncluded(boolean a_WorkingIncluded)

Sets the value of the attribute: WORKING_INCLUDED. If true, include any working copies I may have.

Supported API: true

Parameters:

a_WorkingIncluded -

getView

public View getView()

Gets the value of the attribute: VIEW. If set, only those objects assigned to the view or view-independent are returned. If no WTParts match the view, the parent is checked (until there is either at least one match or no parent). If not set, only view-independent parts are returned.

Supported API: true

Returns:

View

setView

public void setView(View a_View)
             throws WTPropertyVetoException

Sets the value of the attribute: VIEW. If set, only those objects assigned to the view or view-independent are returned. If no WTParts match the view, the parent is checked (until there is either at least one match or no parent). If not set, only view-independent parts are returned.

Supported API: true

Parameters:

a_View -

Throws:

WTPropertyVetoException

newWTPartStandardConfigSpec

public static WTPartStandardConfigSpec newWTPartStandardConfigSpec()
                                                            throws WTException

Construct a default WTPartStandardConfigSpec.

Supported API: true

Returns:

WTPartStandardConfigSpec

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

Throws:

WTException

newWTPartStandardConfigSpec

public static WTPartStandardConfigSpec newWTPartStandardConfigSpec(View view,
                                                                   State lifeCycleState)
                                                            throws WTException

Construct a WTPartStandardConfigSpec, setting the view and lifeCycleState to the passed-in values.

Supported API: true

Parameters:

view -

lifeCycleState -

Returns:

WTPartStandardConfigSpec

Throws:

WTException

initialize

protected void initialize(View view,
                          State lifeCycleState)
                   throws WTException

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

Supported API: true

Parameters:

view -

lifeCycleState -

Throws:

WTException

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