wt.lifecycle
Class Phase

java.lang.Object
  wt.fc.WTObject
      wt.lifecycle.Phase

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public final class Phase

extends WTObject

implements Externalizable

Phase captures run-time behavior for a specific phase for a specific LifeCycleManaged object. This includes role player dispositions, history tracking and next phase information.

Use the newPhase static factory method(s), not the Phase 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: false

Extendable: false

See Also:

PhaseTemplate, Criterion, LifeCycleSignature, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private Gate	gate
static String	GATE Label for the attribute.
private String	name
static String	NAME Label for the attribute; Phase name derived from phase template name Supported API: false
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
static String	PHASE_TEMPLATE_ID Label for the attribute.
private ObjectReference	phaseTemplateId
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	WF_PROCESS_ID Label for the attribute.
private ObjectReference	wfProcessId

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

Phase()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
Gate	getGate() Gets the object for the association that plays role: GATE.
String	getName() Gets the value of the attribute: NAME.
ObjectReference	getPhaseTemplateId() Gets the object for the association that plays role: PHASE_TEMPLATE_ID.
ObjectReference	getWfProcessId() Gets the object for the association that plays role: WF_PROCESS_ID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
private void	nameValidate(String a_Name)
static Phase	newPhase() Default factory for the class.
private void	phaseTemplateIdValidate(ObjectReference a_PhaseTemplateId)
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(Phase thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setGate(Gate a_Gate) Sets the object for the association that plays role: GATE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setPhaseTemplateId(ObjectReference a_PhaseTemplateId) Sets the object for the association that plays role: PHASE_TEMPLATE_ID.
void	setWfProcessId(ObjectReference a_WfProcessId) Sets the object for the association that plays role: WF_PROCESS_ID.
private void	wfProcessIdValidate(ObjectReference a_WfProcessId)
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.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute; Phase name derived from phase template name

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

PHASE_TEMPLATE_ID

public static final String PHASE_TEMPLATE_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

phaseTemplateId

private ObjectReference phaseTemplateId

GATE

public static final String GATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

gate

private Gate gate

WF_PROCESS_ID

public static final String WF_PROCESS_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

wfProcessId

private ObjectReference wfProcessId

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

Phase

public Phase()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 WTObject

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

getName

public String getName()

Gets the value of the attribute: NAME. Phase name derived from phase template name

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Phase name derived from phase template name

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getPhaseTemplateId

public ObjectReference getPhaseTemplateId()

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

Supported API: false

Returns:

ObjectReference

setPhaseTemplateId

public void setPhaseTemplateId(ObjectReference a_PhaseTemplateId)
                        throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_PhaseTemplateId -

Throws:

WTPropertyVetoException

phaseTemplateIdValidate

private void phaseTemplateIdValidate(ObjectReference a_PhaseTemplateId)
                              throws WTPropertyVetoException

Parameters:

a_PhaseTemplateId -

Throws:

WTPropertyVetoException

getGate

public Gate getGate()

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

Supported API: false

Returns:

Gate

setGate

public void setGate(Gate a_Gate)
             throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Gate -

Throws:

WTPropertyVetoException

getWfProcessId

public ObjectReference getWfProcessId()

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

Supported API: false

Returns:

ObjectReference

setWfProcessId

public void setWfProcessId(ObjectReference a_WfProcessId)
                    throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_WfProcessId -

Throws:

WTPropertyVetoException

wfProcessIdValidate

private void wfProcessIdValidate(ObjectReference a_WfProcessId)
                          throws WTPropertyVetoException

Parameters:

a_WfProcessId -

Throws:

WTPropertyVetoException

newPhase

public static Phase newPhase()
                      throws WTException

Default factory for the class.

Supported API: false

Returns:

Phase

Throws:

WTException

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 WTObject

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 WTObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException