Package wt.epm

Class EPMDocConfigSpec

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._Simple

wt.enterprise.Simple

wt.epm._EPMDocConfigSpec

wt.epm.EPMDocConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.notify._Notifiable, Notifiable, wt.ownership._Ownable, wt.ownership.Ownable, wt.vc.config._PersistableConfigSpec, ConfigSpec, wt.vc.config.PersistableConfigSpec

@GenAsPersistable(superClass=Simple.class,interfaces={wt.ownership.Ownable.class,wt.vc.config.PersistableConfigSpec.class},versions={3730948373789079815L,-3796758962029829978L},properties={@GeneratedProperty(name="baselineActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, theBaselineConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="lifeCycleActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, theLifeCycleConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="folderedActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, the IteratedFolderedConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="effectivityActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="asStoredActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, the asStoredConfigSpec is active",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="promotionNoticeActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, the PromotionNoticeConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="sandboxActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, the SandboxConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="changeActive",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="If true, the EPMDocChangeConfigSpec is active.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="workingIncluded",type=boolean.class,initialValue="true"),@GeneratedProperty(name="baseline",type=BaselineConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="lifeCycle",type=LifeCycleConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="foldered",type=IteratedFolderedConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="effectivity",type=EffectivityConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="asStoredConfig",type=EPMAsStoredConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(columnType=INLINE_BLOB)),@GeneratedProperty(name="sandboxConfig",type=SandboxConfigSpec.class,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(columnType=INLINE_BLOB)),@GeneratedProperty(name="promotionNotice",type=PromotionNoticeConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="change",type=EPMDocChangeConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}))},iconProperties=@IconProperties(standardIcon="wt/clients/images/configspec.gif",openIcon="wt/clients/images/configspec.gif"))
public class EPMDocConfigSpec
extends _EPMDocConfigSpec

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

Fields inherited from class wt.epm._EPMDocConfigSpec

AS_STORED_ACTIVE, AS_STORED_CONFIG, BASELINE, BASELINE_ACTIVE, CHANGE, CHANGE_ACTIVE, EFFECTIVITY, EFFECTIVITY_ACTIVE, FOLDERED, FOLDERED_ACTIVE, LIFE_CYCLE, LIFE_CYCLE_ACTIVE, PROMOTION_NOTICE, PROMOTION_NOTICE_ACTIVE, SANDBOX_ACTIVE

Method Summary

Modifier and Type	Method	Description
ConfigSpec	getActive()	Get the active ConfigSpec.
protected void	initialize(EPMDocChangeConfigSpec change)	Supports initialization, following construction of an instance.
protected void	initialize(EPMAsStoredConfigSpec asStoredConfig)	Supports initialization, following construction of an instance.
protected void	initialize(PromotionNoticeConfigSpec promotionNotice)	Supports initialization, following construction of an instance.
protected void	initialize(SandboxConfigSpec sandboxConfig)	Supports initialization, following construction of an instance.
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(IteratedFolderedConfigSpec foldered)	Supports initialization, following construction of an instance.
protected void	initialize(LifeCycleConfigSpec lifeCycle)	Supports initialization, following construction of an instance.
static EPMDocConfigSpec	newEPMDocConfigSpec()	Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(EPMDocChangeConfigSpec change)	Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(EPMAsStoredConfigSpec asStoredConfig)	Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(PromotionNoticeConfigSpec promotionNotice)	Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(SandboxConfigSpec sandboxConfig)	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(IteratedFolderedConfigSpec foldered)	Supported API: true
static EPMDocConfigSpec	newEPMDocConfigSpec(LifeCycleConfigSpec lifeCycle)	Supported API: true
void	setAsStoredActive(boolean a_AsStoredActive)	Sets the value of the attribute: AS_STORED_ACTIVE.
void	setBaselineActive(boolean a_BaselineActive)	Sets the value of the attribute: BASELINE_ACTIVE.
void	setChangeActive(boolean chngActive)	Sets the value of the attribute: changeActive.
void	setEffectivityActive(boolean a_EffectivityActive)	Sets the value of the attribute: EFFECTIVITY_ACTIVE.
void	setFolderedActive(boolean a_FolderedActive)	Sets the value of the attribute: FOLDERED_ACTIVE.
void	setLatestActive()	Sets all active states to false.
void	setLifeCycleActive(boolean a_LifeCycleActive)	Sets the value of the attribute: LIFE_CYCLE_ACTIVE.
void	setPromotionNoticeActive(boolean a_PromotionNoticeActive)	Sets the value of the attribute: PROMOTION_NOTICE_ACTIVE.
void	setSandboxActive(boolean a_SandboxActive)	Sets the value of the attribute: SANDBOX_ACTIVE.

Methods inherited from class wt.epm._EPMDocConfigSpec

getAsStoredConfig, getBaseline, getChange, getEffectivity, getFoldered, getLifeCycle, getPromotionNotice, isAsStoredActive, isBaselineActive, isChangeActive, isEffectivityActive, isFolderedActive, isLifeCycleActive, isPromotionNoticeActive, isSandboxActive, setAsStoredConfig, setBaseline, setChange, setEffectivity, setFoldered, setLifeCycle, setPromotionNotice

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

Methods inherited from interface wt.fc.Persistable

checkAttributes

Method Details

setBaselineActive

public void setBaselineActive(boolean a_BaselineActive)

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

Supported API: true

Overrides:

setBaselineActive in class _EPMDocConfigSpec

Parameters:

a_BaselineActive -

See Also:

• EPMDocConfigSpec

setLifeCycleActive

public void setLifeCycleActive(boolean a_LifeCycleActive)

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

Supported API: true

Overrides:

setLifeCycleActive in class _EPMDocConfigSpec

Parameters:

a_LifeCycleActive -

See Also:

• EPMDocConfigSpec

setFolderedActive

public void setFolderedActive(boolean a_FolderedActive)

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

Supported API: true

Overrides:

setFolderedActive in class _EPMDocConfigSpec

Parameters:

a_FolderedActive -

See Also:

• EPMDocConfigSpec

setEffectivityActive

public void setEffectivityActive(boolean a_EffectivityActive)

Sets the value of the attribute: EFFECTIVITY_ACTIVE.

Supported API: true

Overrides:

setEffectivityActive in class _EPMDocConfigSpec

Parameters:

a_EffectivityActive -

See Also:

• EPMDocConfigSpec

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

Overrides:

setAsStoredActive in class _EPMDocConfigSpec

Parameters:

a_AsStoredActive -

See Also:

• EPMDocConfigSpec

setPromotionNoticeActive

public void setPromotionNoticeActive(boolean a_PromotionNoticeActive)

Sets the value of the attribute: PROMOTION_NOTICE_ACTIVE. If true, the PromotionNoticeConfigSpec is active.

Supported API: true

Overrides:

setPromotionNoticeActive in class _EPMDocConfigSpec

Parameters:

a_PromotionNoticeActive -

See Also:

• EPMDocConfigSpec

setSandboxActive

public void setSandboxActive(boolean a_SandboxActive)

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

Supported API: true

Overrides:

setSandboxActive in class _EPMDocConfigSpec

Parameters:

a_SandboxActive -

See Also:

• EPMDocConfigSpec

setChangeActive

public void setChangeActive(boolean chngActive)

Sets the value of the attribute: changeActive. If true, the EPMDocChangeConfigSpec is active.

Supported API: true

Overrides:

setChangeActive in class _EPMDocConfigSpec

Parameters:

chngActive -

See Also:

• EPMDocConfigSpec

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(SandboxConfigSpec sandboxConfig)
                                            throws WTException

Supported API: true

Parameters:

sandboxConfig -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

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

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(PromotionNoticeConfigSpec promotionNotice)
                                            throws WTException

Supported API: true

Parameters:

promotionNotice -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(PromotionNoticeConfigSpec promotionNotice)
                   throws WTException

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

Supported API: true

Parameters:

promotionNotice -

Throws:

WTException

newEPMDocConfigSpec

public static EPMDocConfigSpec newEPMDocConfigSpec(EPMDocChangeConfigSpec change)
                                            throws WTException

Supported API: true

Parameters:

change -

Returns:

EPMDocConfigSpec

Throws:

WTException

initialize

protected void initialize(EPMDocChangeConfigSpec change)
                   throws WTException

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

Supported API: true

Parameters:

change -

Throws:

WTException