wt.configuration
Class SerialNumberedConfiguredInstanceConfigSpec

java.lang.Object
  wt.configuration.SerialNumberedConfiguredInstanceConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ConfigSpec

public class SerialNumberedConfiguredInstanceConfigSpec
extends Object
implements NetFactor, ConfigSpec, Externalizable

The config spec used by SerialNumberedConfiguredInstanceVersion objects. This config spec will use the configuration to navigate the ConfigurationManageable elements and the date/planningDate to resolve versions of instances mapped (allocated) by this instance. To further traverse those mapped instances, create a new config spec for them.

Use the newSerialNumberedConfiguredInstanceConfigSpec static factory method(s), not the SerialNumberedConfiguredInstanceConfigSpec 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	DATE Label for the attribute.
static String	INSTANCE Label for the attribute.
static String	PLANNING_DATE Label for the attribute.
static String	STATE Label for the attribute.

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.
Timestamp	getDate() Gets the value of the attribute: DATE.
SerialNumberedConfiguredInstanceVersion	getInstance() Gets the value of the attribute: INSTANCE.
State	getState() Gets the value of the attribute: STATE.
protected void	initialize(SerialNumberedConfiguredInstanceVersion instance, State state) Supports initialization, following construction of an instance.
protected void	initialize(SerialNumberedConfiguredInstanceVersion instance, Timestamp date, boolean planningDate) Supports initialization, following construction of an instance.
protected void	initialize(State state) Supports initialization, following construction of an instance.
boolean	isPlanningDate() Gets the value of the attribute: PLANNING_DATE.
static SerialNumberedConfiguredInstanceConfigSpec	newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance, State state) Supported API: true
static SerialNumberedConfiguredInstanceConfigSpec	newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance, Timestamp date, boolean planningDate) Supported API: true
static SerialNumberedConfiguredInstanceConfigSpec	newSerialNumberedConfiguredInstanceConfigSpec(State state) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setDate(Timestamp a_Date) Sets the value of the attribute: DATE.
void	setInstance(SerialNumberedConfiguredInstanceVersion a_Instance) Sets the value of the attribute: INSTANCE.
void	setPlanningDate(boolean a_PlanningDate) Sets the value of the attribute: PLANNING_DATE.
void	setState(State a_State) Sets the value of the attribute: STATE.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final String INSTANCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DATE

public static final String DATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

PLANNING_DATE

public static final String PLANNING_DATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

STATE

public static final String STATE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getInstance

public SerialNumberedConfiguredInstanceVersion getInstance()

Gets the value of the attribute: INSTANCE.

Supported API: true

Returns:

SerialNumberedConfiguredInstanceVersion

setInstance

public void setInstance(SerialNumberedConfiguredInstanceVersion a_Instance)
                 throws WTPropertyVetoException

Sets the value of the attribute: INSTANCE.

Supported API: true

Parameters:

a_Instance -

Throws:

WTPropertyVetoException

getDate

public Timestamp getDate()

Gets the value of the attribute: DATE.

Supported API: true

Returns:

Timestamp

setDate

public void setDate(Timestamp a_Date)
             throws WTPropertyVetoException

Sets the value of the attribute: DATE.

Supported API: true

Parameters:

a_Date -

Throws:

WTPropertyVetoException

isPlanningDate

public boolean isPlanningDate()

Gets the value of the attribute: PLANNING_DATE.

Supported API: true

Returns:

boolean

setPlanningDate

public void setPlanningDate(boolean a_PlanningDate)
                     throws WTPropertyVetoException

Sets the value of the attribute: PLANNING_DATE.

Supported API: true

Parameters:

a_PlanningDate -

Throws:

WTPropertyVetoException

getState

public State getState()

Gets the value of the attribute: STATE.

Supported API: true

Returns:

State

setState

public void setState(State a_State)
              throws WTPropertyVetoException

Sets the value of the attribute: STATE.

Supported API: true

Parameters:

a_State -

Throws:

WTPropertyVetoException

newSerialNumberedConfiguredInstanceConfigSpec

public static SerialNumberedConfiguredInstanceConfigSpec newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance,
                                                                                                       Timestamp date,
                                                                                                       boolean planningDate)
                                                                                                throws WTPropertyVetoException

Supported API: true

Parameters:

instance -

date -

planningDate -

Returns:

SerialNumberedConfiguredInstanceConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(SerialNumberedConfiguredInstanceVersion instance,
                          Timestamp date,
                          boolean planningDate)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

instance -

date -

planningDate -

Throws:

WTPropertyVetoException

newSerialNumberedConfiguredInstanceConfigSpec

public static SerialNumberedConfiguredInstanceConfigSpec newSerialNumberedConfiguredInstanceConfigSpec(SerialNumberedConfiguredInstanceVersion instance,
                                                                                                       State state)
                                                                                                throws WTPropertyVetoException

Supported API: true

Parameters:

instance -

state -

Returns:

SerialNumberedConfiguredInstanceConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(SerialNumberedConfiguredInstanceVersion instance,
                          State state)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

instance -

state -

Throws:

WTPropertyVetoException

newSerialNumberedConfiguredInstanceConfigSpec

public static SerialNumberedConfiguredInstanceConfigSpec newSerialNumberedConfiguredInstanceConfigSpec(State state)
                                                                                                throws WTPropertyVetoException

Supported API: true

Parameters:

state -

Returns:

SerialNumberedConfiguredInstanceConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(State state)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

state -

Throws:

WTPropertyVetoException

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