wt.lifecycle
Class LifeCycleHistory

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

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class LifeCycleHistory

extends WTObject

implements Externalizable

LifeCycleHistory captures an audit traill for an object as it moves through a LifeCycle. This history includes the who and when of life cycle events, signatures and criteria evaluation results.

Use the newLifeCycleHistory static factory method(s), not the LifeCycleHistory 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:

Phase, LifeCycleSignature, Serialized Form

Field Summary

private String	action
static String	ACTION Label for the attribute; The action associated with this object.
private static int	ACTION_UPPER_LIMIT
static String	ACTOR_NAME Label for the attribute; The name of the performer of the action.
private static int	ACTOR_NAME_UPPER_LIMIT
private String	actorName
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	LIFE_CYCLE_NAME Label for the attribute; The name of the LifeCycle Supported API: false
private static int	LIFE_CYCLE_NAME_UPPER_LIMIT
private String	lifeCycleName
protected static long	OLD_FORMAT_VERSION_UID
static String	PHASE_NAME Label for the attribute; The name of the Phase Supported API: false
private static int	PHASE_NAME_UPPER_LIMIT
private String	phaseName
private static String	RESOURCE
(package private) static long	serialVersionUID
private State	state
static String	STATE Label for the attribute; The state of the associated object after the action was performed.
private static int	STATE_UPPER_LIMIT
static String	TEAM_TEMPLATE_IDENTITY Label for the attribute; The identity of the Team Template.
private static int	TEAM_TEMPLATE_IDENTITY_UPPER_LIMIT
private String	teamTemplateIdentity

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

LifeCycleHistory()

Method Summary

private void	actionValidate(String a_Action)
private void	actorNameValidate(String a_ActorName)
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	getAction() Gets the value of the attribute: ACTION.
String	getActorName() Gets the value of the attribute: ACTOR_NAME.
String	getConceptualClassname() Deprecated.
String	getLifeCycleName() Gets the value of the attribute: LIFE_CYCLE_NAME.
String	getPhaseName() Gets the value of the attribute: PHASE_NAME.
State	getState() Gets the value of the attribute: STATE.
String	getTeamTemplateIdentity() Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	lifeCycleNameValidate(String a_LifeCycleName)
static LifeCycleHistory	newLifeCycleHistory() Default factory for the class.
private void	phaseNameValidate(String a_PhaseName)
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(LifeCycleHistory thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAction(String a_Action) Sets the value of the attribute: ACTION.
void	setActorName(String a_ActorName) Sets the value of the attribute: ACTOR_NAME.
void	setLifeCycleName(String a_LifeCycleName) Sets the value of the attribute: LIFE_CYCLE_NAME.
void	setPhaseName(String a_PhaseName) Sets the value of the attribute: PHASE_NAME.
void	setState(State a_State) Sets the value of the attribute: STATE.
void	setTeamTemplateIdentity(String a_TeamTemplateIdentity) Sets the value of the attribute: TEAM_TEMPLATE_IDENTITY.
private void	teamTemplateIdentityValidate(String a_TeamTemplateIdentity)
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, initialize, 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

ACTION

public static final String ACTION

Label for the attribute; The action associated with this object. Required attribute.

Supported API: false

See Also:

Constant Field Values

ACTION_UPPER_LIMIT

private static int ACTION_UPPER_LIMIT

action

private String action

ACTOR_NAME

public static final String ACTOR_NAME

Label for the attribute; The name of the performer of the action. Required attribute.

Supported API: false

See Also:

Constant Field Values

ACTOR_NAME_UPPER_LIMIT

private static int ACTOR_NAME_UPPER_LIMIT

actorName

private String actorName

STATE

public static final String STATE

Label for the attribute; The state of the associated object after the action was performed.

Supported API: false

See Also:

Constant Field Values

STATE_UPPER_LIMIT

private static int STATE_UPPER_LIMIT

state

private State state

LIFE_CYCLE_NAME

public static final String LIFE_CYCLE_NAME

Label for the attribute; The name of the LifeCycle

Supported API: false

See Also:

Constant Field Values

LIFE_CYCLE_NAME_UPPER_LIMIT

private static int LIFE_CYCLE_NAME_UPPER_LIMIT

lifeCycleName

private String lifeCycleName

PHASE_NAME

public static final String PHASE_NAME

Label for the attribute; The name of the Phase

Supported API: false

See Also:

Constant Field Values

PHASE_NAME_UPPER_LIMIT

private static int PHASE_NAME_UPPER_LIMIT

phaseName

private String phaseName

TEAM_TEMPLATE_IDENTITY

public static final String TEAM_TEMPLATE_IDENTITY

Label for the attribute; The identity of the Team Template.

Supported API: false

See Also:

Constant Field Values

TEAM_TEMPLATE_IDENTITY_UPPER_LIMIT

private static int TEAM_TEMPLATE_IDENTITY_UPPER_LIMIT

teamTemplateIdentity

private String teamTemplateIdentity

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

LifeCycleHistory

public LifeCycleHistory()

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(LifeCycleHistory 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

getAction

public String getAction()

Gets the value of the attribute: ACTION. The action associated with this object. Required attribute.

Supported API: false

Returns:

String

setAction

public void setAction(String a_Action)
               throws WTPropertyVetoException

Sets the value of the attribute: ACTION. The action associated with this object. Required attribute.

Supported API: false

Parameters:

a_Action -

Throws:

WTPropertyVetoException

actionValidate

private void actionValidate(String a_Action)
                     throws WTPropertyVetoException

Parameters:

a_Action -

Throws:

WTPropertyVetoException

getActorName

public String getActorName()

Gets the value of the attribute: ACTOR_NAME. The name of the performer of the action. Required attribute.

Supported API: false

Returns:

String

setActorName

public void setActorName(String a_ActorName)
                  throws WTPropertyVetoException

Sets the value of the attribute: ACTOR_NAME. The name of the performer of the action. Required attribute.

Supported API: false

Parameters:

a_ActorName -

Throws:

WTPropertyVetoException

actorNameValidate

private void actorNameValidate(String a_ActorName)
                        throws WTPropertyVetoException

Parameters:

a_ActorName -

Throws:

WTPropertyVetoException

getState

public State getState()

Gets the value of the attribute: STATE. The state of the associated object after the action was performed.

Supported API: false

Returns:

State

setState

public void setState(State a_State)
              throws WTPropertyVetoException

Sets the value of the attribute: STATE. The state of the associated object after the action was performed.

Supported API: false

Parameters:

a_State -

Throws:

WTPropertyVetoException

getLifeCycleName

public String getLifeCycleName()

Gets the value of the attribute: LIFE_CYCLE_NAME. The name of the LifeCycle

Supported API: false

Returns:

String

setLifeCycleName

public void setLifeCycleName(String a_LifeCycleName)
                      throws WTPropertyVetoException

Sets the value of the attribute: LIFE_CYCLE_NAME. The name of the LifeCycle

Supported API: false

Parameters:

a_LifeCycleName -

Throws:

WTPropertyVetoException

lifeCycleNameValidate

private void lifeCycleNameValidate(String a_LifeCycleName)
                            throws WTPropertyVetoException

Parameters:

a_LifeCycleName -

Throws:

WTPropertyVetoException

getPhaseName

public String getPhaseName()

Gets the value of the attribute: PHASE_NAME. The name of the Phase

Supported API: false

Returns:

String

setPhaseName

public void setPhaseName(String a_PhaseName)
                  throws WTPropertyVetoException

Sets the value of the attribute: PHASE_NAME. The name of the Phase

Supported API: false

Parameters:

a_PhaseName -

Throws:

WTPropertyVetoException

phaseNameValidate

private void phaseNameValidate(String a_PhaseName)
                        throws WTPropertyVetoException

Parameters:

a_PhaseName -

Throws:

WTPropertyVetoException

getTeamTemplateIdentity

public String getTeamTemplateIdentity()

Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY. The identity of the Team Template.

Supported API: false

Returns:

String

setTeamTemplateIdentity

public void setTeamTemplateIdentity(String a_TeamTemplateIdentity)
                             throws WTPropertyVetoException

Sets the value of the attribute: TEAM_TEMPLATE_IDENTITY. The identity of the Team Template.

Supported API: false

Parameters:

a_TeamTemplateIdentity -

Throws:

WTPropertyVetoException

teamTemplateIdentityValidate

private void teamTemplateIdentityValidate(String a_TeamTemplateIdentity)
                                   throws WTPropertyVetoException

Parameters:

a_TeamTemplateIdentity -

Throws:

WTPropertyVetoException

newLifeCycleHistory

public static LifeCycleHistory newLifeCycleHistory()
                                            throws WTException

Default factory for the class.

Supported API: false

Returns:

LifeCycleHistory

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