wt.epm
Class EPMDocConfigSpec

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

All Implemented Interfaces:

AccessControlled, BusinessInformation, ConfigSpec, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, PersistableConfigSpec, Serializable

public class EPMDocConfigSpec

extends Simple

implements Ownable, 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.
private boolean	asStoredActive
private EPMAsStoredConfigSpec	asStoredConfig
private BaselineConfigSpec	baseline
static String	BASELINE Label for the attribute.
static String	BASELINE_ACTIVE Label for the attribute; If true, theBaselineConfigSpec is active.
private boolean	baselineActive
private static String	CLASSNAME
private EffectivityConfigSpec	effectivity
static String	EFFECTIVITY Label for the attribute.
static String	EFFECTIVITY_ACTIVE Label for the attribute.
private boolean	effectivityActive
static long	EXTERNALIZATION_VERSION_UID
private IteratedFolderedConfigSpec	foldered
static String	FOLDERED Label for the attribute.
static String	FOLDERED_ACTIVE Label for the attribute; If true, the IteratedFolderedConfigSpec is active.
private boolean	folderedActive
static String	LIFE_CYCLE Label for the attribute.
static String	LIFE_CYCLE_ACTIVE Label for the attribute; If true, theLifeCycleConfigSpec is active.
private LifeCycleConfigSpec	lifeCycle
private boolean	lifeCycleActive
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
static String	SANDBOX_ACTIVE Label for the attribute; If true, the SandboxConfigSpec is active.
static String	SANDBOX_CONFIG Label for the attribute.
private boolean	sandboxActive
private SandboxConfigSpec	sandboxConfig
(package private) static long	serialVersionUID

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMDocConfigSpec()

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.
WTObject	duplicate() Creates a deep copy of this PersistableConfigSpec.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
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.
String	getConceptualClassname() Deprecated.
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.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
SandboxConfigSpec	getSandboxConfig() Gets the object for the association that plays role: SANDBOX_CONFIG.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
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(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(SandboxConfigSpec sandboxConfig) Supported API: true
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(EPMDocConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setSandboxActive(boolean a_SandboxActive) Sets the value of the attribute: SANDBOX_ACTIVE.
void	setSandboxConfig(SandboxConfigSpec a_SandboxConfig) Sets the object for the association that plays role: SANDBOX_CONFIG.
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 wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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

baselineActive

private boolean baselineActive

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

lifeCycleActive

private boolean lifeCycleActive

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

folderedActive

private boolean folderedActive

EFFECTIVITY_ACTIVE

public static final String EFFECTIVITY_ACTIVE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

effectivityActive

private boolean effectivityActive

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

asStoredActive

private boolean asStoredActive

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

sandboxActive

private boolean sandboxActive

BASELINE

public static final String BASELINE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

baseline

private BaselineConfigSpec baseline

LIFE_CYCLE

public static final String LIFE_CYCLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

lifeCycle

private LifeCycleConfigSpec lifeCycle

FOLDERED

public static final String FOLDERED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

foldered

private IteratedFolderedConfigSpec foldered

EFFECTIVITY

public static final String EFFECTIVITY

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

effectivity

private EffectivityConfigSpec effectivity

AS_STORED_CONFIG

public static final String AS_STORED_CONFIG

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

asStoredConfig

private EPMAsStoredConfigSpec asStoredConfig

SANDBOX_CONFIG

public static final String SANDBOX_CONFIG

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

sandboxConfig

private SandboxConfigSpec sandboxConfig

ownership

private Ownership ownership

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

EPMDocConfigSpec

public EPMDocConfigSpec()

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

Overrides:

writeExternal in class Simple

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

Overrides:

readExternal in class Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMDocConfigSpec 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

Overrides:

writeExternal in class Simple

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

Overrides:

readExternal in class Simple

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

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 -

getSandboxConfig

public SandboxConfigSpec getSandboxConfig()

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

Supported API: false

Returns:

SandboxConfigSpec

setSandboxConfig

public void setSandboxConfig(SandboxConfigSpec a_SandboxConfig)

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

Supported API: false

Parameters:

a_SandboxConfig -

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

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

duplicate

public WTObject duplicate()
                   throws WTException

Creates a deep copy of this PersistableConfigSpec. The copy is not yet persisted. Equivalent to or implemented by the method with the same signature in WTObject.

Supported API: false

Specified by:

duplicate in interface PersistableConfigSpec

Overrides:

duplicate in class WTObject

Returns:

WTObject

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

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Simple

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Simple

Supported API: false

Overrides:

initialize in class Simple

Throws:

WTException