wt.part
Class WTPartConfigSpec

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.part.WTPartConfigSpec

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 WTPartConfigSpec
extends Simple
implements Ownable, wt.vc.config.PersistableConfigSpec, Externalizable

The reference implementation of a user visible config spec, used to select WTParts, which aggregates WTPartBaselineConfigSpec, WTPartEffectivityConfigSpec, and WTPartStandardConfigSpec. Only one of these aggregated config specs may be active at one time.

Use the newWTPartConfigSpec static factory method(s), not the WTPartConfigSpec 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	BASELINE Label for the attribute.
static String	BASELINE_ACTIVE Label for the attribute; If true, the WTPartBaselineConfigSpec is active.
static String	EFFECTIVITY Label for the attribute.
static String	EFFECTIVITY_ACTIVE Label for the attribute; If true, the WTPartEffectivityConfigSpec is active.
static String	SANDBOX Label for the attribute.
static String	SANDBOX_ACTIVE Label for the attribute; If true, the SandboxConfigSpec is active.
static String	STANDARD Label for the attribute.
static String	STANDARD_ACTIVE Label for the attribute; If true, the WTPartStandardConfigSpec 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.
WTPartBaselineConfigSpec	getBaseline() Gets the object for the association that plays role: BASELINE.
WTPartEffectivityConfigSpec	getEffectivity() Gets the object for the association that plays role: EFFECTIVITY.
wt.sandbox.SandboxConfigSpec	getSandbox() Gets the value of the attribute: SANDBOX.
WTPartStandardConfigSpec	getStandard() Gets the object for the association that plays role: STANDARD.
protected void	initialize(wt.sandbox.SandboxConfigSpec sandbox) Supports initialization, following construction of an instance.
protected void	initialize(WTPartBaselineConfigSpec baseline) Supports initialization, following construction of an instance.
protected void	initialize(WTPartBaselineConfigSpec baseline, WTPartEffectivityConfigSpec effectivity, WTPartStandardConfigSpec standard) Supports initialization, following construction of an instance.
protected void	initialize(WTPartEffectivityConfigSpec effectivity) Supports initialization, following construction of an instance.
protected void	initialize(WTPartStandardConfigSpec standard) Supports initialization, following construction of an instance.
boolean	isBaselineActive() Gets the value of the attribute: BASELINE_ACTIVE.
boolean	isEffectivityActive() Gets the value of the attribute: EFFECTIVITY_ACTIVE.
boolean	isSandboxActive() Gets the value of the attribute: SANDBOX_ACTIVE.
boolean	isStandardActive() Gets the value of the attribute: STANDARD_ACTIVE.
static WTPartConfigSpec	newWTPartConfigSpec() Supported API: true
static WTPartConfigSpec	newWTPartConfigSpec(wt.sandbox.SandboxConfigSpec sandbox) Supported API: true
static WTPartConfigSpec	newWTPartConfigSpec(WTPartBaselineConfigSpec baseline) Supported API: true
static WTPartConfigSpec	newWTPartConfigSpec(WTPartBaselineConfigSpec baseline, WTPartEffectivityConfigSpec effectivity, WTPartStandardConfigSpec standard) Supported API: true
static WTPartConfigSpec	newWTPartConfigSpec(WTPartEffectivityConfigSpec effectivity) Supported API: true
static WTPartConfigSpec	newWTPartConfigSpec(WTPartStandardConfigSpec standard) Supported API: true
QueryResult	process(QueryResult results) Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
void	setBaseline(WTPartBaselineConfigSpec 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(WTPartEffectivityConfigSpec 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	setSandbox(wt.sandbox.SandboxConfigSpec a_Sandbox) Sets the value of the attribute: SANDBOX.
void	setSandboxActive(boolean a_SandboxActive) Sets the value of the attribute: SANDBOX_ACTIVE.
void	setStandard(WTPartStandardConfigSpec a_Standard) Sets the object for the association that plays role: STANDARD.
void	setStandardActive(boolean a_StandardActive) Sets the value of the attribute: STANDARD_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, the WTPartBaselineConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

EFFECTIVITY_ACTIVE

public static final String EFFECTIVITY_ACTIVE

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

Supported API: true

See Also:

Constant Field Values

STANDARD_ACTIVE

public static final String STANDARD_ACTIVE

Label for the attribute; If true, the WTPartStandardConfigSpec 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

SANDBOX

public static final String SANDBOX

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

STANDARD

public static final String STANDARD

Label for the attribute.

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

EFFECTIVITY

public static final String EFFECTIVITY

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, the WTPartBaselineConfigSpec is active.

Supported API: true

Returns:

boolean

setBaselineActive

public void setBaselineActive(boolean a_BaselineActive)

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

Supported API: true

Parameters:

a_BaselineActive -

isEffectivityActive

public boolean isEffectivityActive()

Gets the value of the attribute: EFFECTIVITY_ACTIVE. If true, the WTPartEffectivityConfigSpec is active.

Supported API: true

Returns:

boolean

setEffectivityActive

public void setEffectivityActive(boolean a_EffectivityActive)

Sets the value of the attribute: EFFECTIVITY_ACTIVE. If true, the WTPartEffectivityConfigSpec is active.

Supported API: true

Parameters:

a_EffectivityActive -

isStandardActive

public boolean isStandardActive()

Gets the value of the attribute: STANDARD_ACTIVE. If true, the WTPartStandardConfigSpec is active.

Supported API: true

Returns:

boolean

setStandardActive

public void setStandardActive(boolean a_StandardActive)

Sets the value of the attribute: STANDARD_ACTIVE. If true, the WTPartStandardConfigSpec is active.

Supported API: true

Parameters:

a_StandardActive -

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 -

getSandbox

public wt.sandbox.SandboxConfigSpec getSandbox()

Gets the value of the attribute: SANDBOX.

Supported API: true

Returns:

SandboxConfigSpec

setSandbox

public void setSandbox(wt.sandbox.SandboxConfigSpec a_Sandbox)

Sets the value of the attribute: SANDBOX.

Supported API: true

Parameters:

a_Sandbox -

getStandard

public WTPartStandardConfigSpec getStandard()

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

Supported API: true

Returns:

WTPartStandardConfigSpec

setStandard

public void setStandard(WTPartStandardConfigSpec a_Standard)

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

Supported API: true

Parameters:

a_Standard -

getBaseline

public WTPartBaselineConfigSpec getBaseline()

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

Supported API: true

Returns:

WTPartBaselineConfigSpec

setBaseline

public void setBaseline(WTPartBaselineConfigSpec a_Baseline)

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

Supported API: true

Parameters:

a_Baseline -

getEffectivity

public WTPartEffectivityConfigSpec getEffectivity()

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

Supported API: true

Returns:

WTPartEffectivityConfigSpec

setEffectivity

public void setEffectivity(WTPartEffectivityConfigSpec a_Effectivity)

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

Supported API: true

Parameters:

a_Effectivity -

getActive

public ConfigSpec getActive()

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

Supported API: true

Returns:

ConfigSpec

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec()
                                            throws WTException

Supported API: true

Returns:

WTPartConfigSpec

Throws:

WTException

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec(WTPartBaselineConfigSpec baseline)
                                            throws WTException

Supported API: true

Parameters:

baseline -

Returns:

WTPartConfigSpec

Throws:

WTException

initialize

protected void initialize(WTPartBaselineConfigSpec 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

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec(WTPartEffectivityConfigSpec effectivity)
                                            throws WTException

Supported API: true

Parameters:

effectivity -

Returns:

WTPartConfigSpec

Throws:

WTException

initialize

protected void initialize(WTPartEffectivityConfigSpec 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

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec(WTPartStandardConfigSpec standard)
                                            throws WTException

Supported API: true

Parameters:

standard -

Returns:

WTPartConfigSpec

Throws:

WTException

initialize

protected void initialize(WTPartStandardConfigSpec standard)
                   throws WTException

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

Supported API: true

Parameters:

standard -

Throws:

WTException

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec(WTPartBaselineConfigSpec baseline,
                                                   WTPartEffectivityConfigSpec effectivity,
                                                   WTPartStandardConfigSpec standard)
                                            throws WTException

Supported API: true

Parameters:

baseline -

effectivity -

standard -

Returns:

WTPartConfigSpec

Throws:

WTException

initialize

protected void initialize(WTPartBaselineConfigSpec baseline,
                          WTPartEffectivityConfigSpec effectivity,
                          WTPartStandardConfigSpec standard)
                   throws WTException

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

Supported API: true

Parameters:

baseline -

effectivity -

standard -

Throws:

WTException

newWTPartConfigSpec

public static WTPartConfigSpec newWTPartConfigSpec(wt.sandbox.SandboxConfigSpec sandbox)
                                            throws WTException

Supported API: true

Parameters:

sandbox -

Returns:

WTPartConfigSpec

Throws:

WTException

initialize

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

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

Supported API: true

Parameters:

sandbox -

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