wt.doc
Class WTDocumentConfigSpec

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.doc.WTDocumentConfigSpec

All Implemented Interfaces:

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

public class WTDocumentConfigSpec

extends Simple

implements Ownable, PersistableConfigSpec, Externalizable

The config spec for use by WTDocuments. It aggregates BaselineConfigSpec and WTDocumenttStandardConfigSpec. Only one of these may be active at a time.

Use the newWTDocumentConfigSpec static factory method(s), not the WTDocumentConfigSpec 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

private BaselineConfigSpec	baseline
static String	BASELINE Label for the attribute.
static String	BASELINE_ACTIVE Label for the attribute; If true, the BaselineConfigSpec is active.
private boolean	baselineActive
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID
private WTDocumentStandardConfigSpec	standard
static String	STANDARD Label for the attribute.
static String	STANDARD_ACTIVE Label for the attribute; If true, the WTDocumentStandardConfigSpec is active.
private boolean	standardActive

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

WTDocumentConfigSpec()

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.
BaselineConfigSpec	getBaseline() Gets the object for the association that plays role: BASELINE.
String	getConceptualClassname() Deprecated.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
WTDocumentStandardConfigSpec	getStandard() Gets the object for the association that plays role: STANDARD.
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, WTDocumentStandardConfigSpec standard) Supports initialization, following construction of an instance.
protected void	initialize(WTDocumentStandardConfigSpec standard) Supports initialization, following construction of an instance.
boolean	isBaselineActive() Gets the value of the attribute: BASELINE_ACTIVE.
boolean	isStandardActive() Gets the value of the attribute: STANDARD_ACTIVE.
static WTDocumentConfigSpec	newWTDocumentConfigSpec() Supported API: true
static WTDocumentConfigSpec	newWTDocumentConfigSpec(BaselineConfigSpec baseline) Supported API: true
static WTDocumentConfigSpec	newWTDocumentConfigSpec(BaselineConfigSpec baseline, WTDocumentStandardConfigSpec standard) Supported API: true
static WTDocumentConfigSpec	newWTDocumentConfigSpec(WTDocumentStandardConfigSpec standard) 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(WTDocumentConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setStandard(WTDocumentStandardConfigSpec 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.
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, the BaselineConfigSpec is active.

Supported API: true

See Also:

Constant Field Values

baselineActive

private boolean baselineActive

STANDARD_ACTIVE

public static final String STANDARD_ACTIVE

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

Supported API: true

See Also:

Constant Field Values

standardActive

private boolean standardActive

BASELINE

public static final String BASELINE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

baseline

private BaselineConfigSpec baseline

STANDARD

public static final String STANDARD

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

standard

private WTDocumentStandardConfigSpec standard

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

WTDocumentConfigSpec

public WTDocumentConfigSpec()

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(WTDocumentConfigSpec 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, the BaselineConfigSpec 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 BaselineConfigSpec is active.

Supported API: true

Parameters:

a_BaselineActive -

isStandardActive

public boolean isStandardActive()

Gets the value of the attribute: STANDARD_ACTIVE. If true, the WTDocumentStandardConfigSpec 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 WTDocumentStandardConfigSpec is active.

Supported API: true

Parameters:

a_StandardActive -

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 -

getStandard

public WTDocumentStandardConfigSpec getStandard()

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

Supported API: true

Returns:

WTDocumentStandardConfigSpec

setStandard

public void setStandard(WTDocumentStandardConfigSpec a_Standard)

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

Supported API: true

Parameters:

a_Standard -

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

newWTDocumentConfigSpec

public static WTDocumentConfigSpec newWTDocumentConfigSpec()
                                                    throws WTException

Supported API: true

Returns:

WTDocumentConfigSpec

Throws:

WTException

newWTDocumentConfigSpec

public static WTDocumentConfigSpec newWTDocumentConfigSpec(BaselineConfigSpec baseline)
                                                    throws WTException

Supported API: true

Parameters:

baseline -

Returns:

WTDocumentConfigSpec

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

newWTDocumentConfigSpec

public static WTDocumentConfigSpec newWTDocumentConfigSpec(WTDocumentStandardConfigSpec standard)
                                                    throws WTException

Supported API: true

Parameters:

standard -

Returns:

WTDocumentConfigSpec

Throws:

WTException

initialize

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

newWTDocumentConfigSpec

public static WTDocumentConfigSpec newWTDocumentConfigSpec(BaselineConfigSpec baseline,
                                                           WTDocumentStandardConfigSpec standard)
                                                    throws WTException

Supported API: true

Parameters:

baseline -

standard -

Returns:

WTDocumentConfigSpec

Throws:

WTException

initialize

protected void initialize(BaselineConfigSpec baseline,
                          WTDocumentStandardConfigSpec standard)
                   throws WTException

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

Supported API: true

Parameters:

baseline -

standard -

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