wt.epm
Class EPMDocConfigSpec

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.epm.EPMDocConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Notifiable, Ownable, ConfigSpec, wt.vc.config.PersistableConfigSpec

public class EPMDocConfigSpec
extends Simple
implements Ownable, wt.vc.config.PersistableConfigSpec, Externalizable

The config spec for use by EPMDocs. It aggregates BaselineConfigSpec, LifeCycleConfigSpec, IteratedFolderedConfigSpec, EPMAsStoredConfigSpec, SandboxConfigSpec and EffectivityConfigSpec. LatestConfigSpec is applied where applicable to ensure only 1 result. Only one of these may be active at a time. If none of these are active, LatestConfigSpec only will be used.

Use the newEPMDocConfigSpec static factory method(s), not the EPMDocConfigSpec 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	AS_STORED_ACTIVE Label for the attribute; If true, the asStoredConfigSpec is active Supported API: true
static String	AS_STORED_CONFIG Label for the attribute.
static String	BASELINE Label for the attribute.
static String	BASELINE_ACTIVE Label for the attribute; If true, theBaselineConfigSpec is active.
static String	EFFECTIVITY Label for the attribute.
static String	EFFECTIVITY_ACTIVE Label for the attribute.
static String	FOLDERED Label for the attribute.
static String	FOLDERED_ACTIVE Label for the attribute; If true, the IteratedFolderedConfigSpec is active.
static String	LIFE_CYCLE Label for the attribute.
static String	LIFE_CYCLE_ACTIVE Label for the attribute; If true, theLifeCycleConfigSpec is active.
static String	SANDBOX_ACTIVE Label for the attribute; If true, the SandboxConfigSpec is active.

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.
ConfigSpec	getActive() Get the active ConfigSpec.
EPMAsStoredConfigSpec	getAsStoredConfig() Gets the object for the association that plays role: AS_STORED_CONFIG.
BaselineConfigSpec	getBaseline() Gets the object for the association that plays role: BASELINE.
EffectivityConfigSpec	getEffectivity() Gets the object for the association that plays role: EFFECTIVITY.
IteratedFolderedConfigSpec	getFoldered() Gets the object for the association that plays role: FOLDERED.
LifeCycleConfigSpec	getLifeCycle() Gets the object for the association that plays role: LIFE_CYCLE.
protected void	initialize(BaselineConfigSpec baseline) Supports initialization, following construction of an instance.
protected void	initialize(BaselineConfigSpec baseline, LifeCycleConfigSpec lifeCycle, IteratedFolderedConfigSpec foldered) Supports initialization, following construction of an instance.
protected void	initialize(EffectivityConfigSpec effectivity) Supports initialization, following construction of an instance.
protected void	initialize(EPMAsStoredConfigSpec asStoredConfig) Supports initialization, following construction of an instance.
protected void	initialize(IteratedFolderedConfigSpec foldered) Supports initialization, following construction of an instance.
protected void	initialize(LifeCycleConfigSpec lifeCycle) Supports initialization, following construction of an instance.
protected void	initialize(wt.sandbox.SandboxConfigSpec sandboxConfig) Supports initialization, following construction of an instance.
boolean	isAsStoredActive() Gets the value of the attribute: AS_STORED_ACTIVE.
boolean	isBaselineActive() Gets the value of the attribute: BASELINE_ACTIVE.
boolean	isEffectivityActive() Gets the value of the attribute: EFFECTIVITY_ACTIVE.
boolean	isFolderedActive() Gets the value of the attribute: FOLDERED_ACTIVE.
boolean	isLifeCycleActive() Gets the value of the attribute: LIFE_CYCLE_ACTIVE.
boolean	isSandboxActive() Gets the value of the attribute: SANDBOX_ACTIVE.
static EPMDocConfigSpec	newEPMDocConfigSpec() Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(BaselineConfigSpec baseline) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(BaselineConfigSpec baseline, LifeCycleConfigSpec lifeCycle, IteratedFolderedConfigSpec foldered) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(EffectivityConfigSpec effectivity) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(EPMAsStoredConfigSpec asStoredConfig) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(IteratedFolderedConfigSpec foldered) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(LifeCycleConfigSpec lifeCycle) Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(wt.sandbox.SandboxConfigSpec sandboxConfig) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setAsStoredActive(boolean a_AsStoredActive) Sets the value of the attribute: AS_STORED_ACTIVE.
void	setAsStoredConfig(EPMAsStoredConfigSpec a_AsStoredConfig) Sets the object for the association that plays role: AS_STORED_CONFIG.
void	setBaseline(BaselineConfigSpec a_Baseline) Sets the object for the association that plays role: BASELINE.
void	setBaselineActive(boolean a_BaselineActive) Sets the value of the attribute: BASELINE_ACTIVE.
void	setEffectivity(EffectivityConfigSpec a_Effectivity) Sets the object for the association that plays role: EFFECTIVITY.
void	setEffectivityActive(boolean a_EffectivityActive) Sets the value of the attribute: EFFECTIVITY_ACTIVE.
void	setFoldered(IteratedFolderedConfigSpec a_Foldered) Sets the object for the association that plays role: FOLDERED.
void	setFolderedActive(boolean a_FolderedActive) Sets the value of the attribute: FOLDERED_ACTIVE.
void	setLatestActive() Sets all active states to false.
void	setLifeCycle(LifeCycleConfigSpec a_LifeCycle) Sets the object for the association that plays role: LIFE_CYCLE.
void	setLifeCycleActive(boolean a_LifeCycleActive) Sets the value of the attribute: LIFE_CYCLE_ACTIVE.
void	setSandboxActive(boolean a_SandboxActive) Sets the value of the attribute: SANDBOX_ACTIVE.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BASELINE_ACTIVE

public static final String BASELINE_ACTIVE

Label for the attribute; If true, theBaselineConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

LIFE_CYCLE_ACTIVE

public static final String LIFE_CYCLE_ACTIVE

Label for the attribute; If true, theLifeCycleConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

FOLDERED_ACTIVE

public static final String FOLDERED_ACTIVE

Label for the attribute; If true, the IteratedFolderedConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

EFFECTIVITY_ACTIVE

public static final String EFFECTIVITY_ACTIVE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

AS_STORED_ACTIVE

public static final String AS_STORED_ACTIVE

Label for the attribute; If true, the asStoredConfigSpec is active

Supported API: true

See Also:

Constant Field Values

SANDBOX_ACTIVE

public static final String SANDBOX_ACTIVE

Label for the attribute; If true, the SandboxConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

BASELINE

public static final String BASELINE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

LIFE_CYCLE

public static final String LIFE_CYCLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

FOLDERED

public static final String FOLDERED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

EFFECTIVITY

public static final String EFFECTIVITY

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

AS_STORED_CONFIG

public static final String AS_STORED_CONFIG

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

isBaselineActive

public boolean isBaselineActive()

Gets the value of the attribute: BASELINE_ACTIVE. If true, theBaselineConfigSpec is active.

Supported API: true

Returns:

boolean

setBaselineActive

public void setBaselineActive(boolean a_BaselineActive)

Sets the value of the attribute: BASELINE_ACTIVE. If true, theBaselineConfigSpec is active.

Supported API: true

Parameters:

a_BaselineActive -

isLifeCycleActive

public boolean isLifeCycleActive()

Gets the value of the attribute: LIFE_CYCLE_ACTIVE. If true, theLifeCycleConfigSpec is active.

Supported API: true

Returns:

boolean

setLifeCycleActive

public void setLifeCycleActive(boolean a_LifeCycleActive)

Sets the value of the attribute: LIFE_CYCLE_ACTIVE. If true, theLifeCycleConfigSpec is active.

Supported API: true

Parameters:

a_LifeCycleActive -

isFolderedActive

public boolean isFolderedActive()

Gets the value of the attribute: FOLDERED_ACTIVE. If true, the IteratedFolderedConfigSpec is active.

Supported API: true

Returns:

boolean

setFolderedActive

public void setFolderedActive(boolean a_FolderedActive)

Sets the value of the attribute: FOLDERED_ACTIVE. If true, the IteratedFolderedConfigSpec is active.

Supported API: true

Parameters:

a_FolderedActive -

isEffectivityActive

public boolean isEffectivityActive()

Gets the value of the attribute: EFFECTIVITY_ACTIVE.

Supported API: true

Returns:

boolean

setEffectivityActive

public void setEffectivityActive(boolean a_EffectivityActive)

Sets the value of the attribute: EFFECTIVITY_ACTIVE.

Supported API: true

Parameters:

a_EffectivityActive -

isAsStoredActive

public boolean isAsStoredActive()

Gets the value of the attribute: AS_STORED_ACTIVE. If true, the asStoredConfigSpec is active

Supported API: true

Returns:

boolean

setAsStoredActive

public void setAsStoredActive(boolean a_AsStoredActive)

Sets the value of the attribute: AS_STORED_ACTIVE. If true, the asStoredConfigSpec is active

Supported API: true

Parameters:

a_AsStoredActive -

isSandboxActive

public boolean isSandboxActive()

Gets the value of the attribute: SANDBOX_ACTIVE. If true, the SandboxConfigSpec is active.

Supported API: true

Returns:

boolean

setSandboxActive

public void setSandboxActive(boolean a_SandboxActive)

Sets the value of the attribute: SANDBOX_ACTIVE. If true, the SandboxConfigSpec is active.

Supported API: true

Parameters:

a_SandboxActive -

getBaseline

public BaselineConfigSpec getBaseline()

Gets the object for the association that plays role: BASELINE.

Supported API: true

Returns:

BaselineConfigSpec

setBaseline

public void setBaseline(BaselineConfigSpec a_Baseline)

Sets the object for the association that plays role: BASELINE.

Supported API: true

Parameters:

a_Baseline -

getLifeCycle

public LifeCycleConfigSpec getLifeCycle()

Gets the object for the association that plays role: LIFE_CYCLE.

Supported API: true

Returns:

LifeCycleConfigSpec

setLifeCycle

public void setLifeCycle(LifeCycleConfigSpec a_LifeCycle)

Sets the object for the association that plays role: LIFE_CYCLE.

Supported API: true

Parameters:

a_LifeCycle -

getFoldered

public IteratedFolderedConfigSpec getFoldered()

Gets the object for the association that plays role: FOLDERED.

Supported API: true

Returns:

IteratedFolderedConfigSpec

setFoldered

public void setFoldered(IteratedFolderedConfigSpec a_Foldered)

Sets the object for the association that plays role: FOLDERED.

Supported API: true

Parameters:

a_Foldered -

getEffectivity

public EffectivityConfigSpec getEffectivity()

Gets the object for the association that plays role: EFFECTIVITY.

Supported API: true

Returns:

EffectivityConfigSpec

setEffectivity

public void setEffectivity(EffectivityConfigSpec a_Effectivity)

Sets the object for the association that plays role: EFFECTIVITY.

Supported API: true

Parameters:

a_Effectivity -

getAsStoredConfig

public EPMAsStoredConfigSpec getAsStoredConfig()

Gets the object for the association that plays role: AS_STORED_CONFIG.

Supported API: true

Returns:

EPMAsStoredConfigSpec

setAsStoredConfig

public void setAsStoredConfig(EPMAsStoredConfigSpec a_AsStoredConfig)

Sets the object for the association that plays role: AS_STORED_CONFIG.

Supported API: true

Parameters:

a_AsStoredConfig -

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec()
                                            throws WTException

Supported API: true

Returns:

EPMDocConfigSpec

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(BaselineConfigSpec baseline)
                                            throws WTException

Supported API: true

Parameters:

baseline -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(BaselineConfigSpec baseline)
                   throws WTException

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

Supported API: true

Parameters:

baseline -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(LifeCycleConfigSpec lifeCycle)
                                            throws WTException

Supported API: true

Parameters:

lifeCycle -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(LifeCycleConfigSpec lifeCycle)
                   throws WTException

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

Supported API: true

Parameters:

lifeCycle -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(IteratedFolderedConfigSpec foldered)
                                            throws WTException

Supported API: true

Parameters:

foldered -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(IteratedFolderedConfigSpec foldered)
                   throws WTException

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

Supported API: true

Parameters:

foldered -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(EPMAsStoredConfigSpec asStoredConfig)
                                            throws WTException

Supported API: true

Parameters:

asStoredConfig -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(EPMAsStoredConfigSpec asStoredConfig)
                   throws WTException

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

Supported API: true

Parameters:

asStoredConfig -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(BaselineConfigSpec baseline,
                                                   LifeCycleConfigSpec lifeCycle,
                                                   IteratedFolderedConfigSpec foldered)
                                            throws WTException

Supported API: true

Parameters:

baseline -

lifeCycle -

foldered -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(BaselineConfigSpec baseline,
                          LifeCycleConfigSpec lifeCycle,
                          IteratedFolderedConfigSpec foldered)
                   throws WTException

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

Supported API: true

Parameters:

baseline -

lifeCycle -

foldered -

Throws:

WTException

getActive

public ConfigSpec getActive()

Get the active ConfigSpec. Returns LatestConfigSpec if there is no active one or if the active one is null.

Supported API: true

Returns:

ConfigSpec

setLatestActive

public void setLatestActive()

Sets all active states to false. This will result in the default LatestConfigSpec being used.

Supported API: true

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(EffectivityConfigSpec effectivity)
                                            throws WTException

Supported API: true

Parameters:

effectivity -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(EffectivityConfigSpec effectivity)
                   throws WTException

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

Supported API: true

Parameters:

effectivity -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(wt.sandbox.SandboxConfigSpec sandboxConfig)
                                            throws WTException

Supported API: true

Parameters:

sandboxConfig -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(wt.sandbox.SandboxConfigSpec sandboxConfig)
                   throws WTException

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

Supported API: true

Parameters:

sandboxConfig -

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