wt.projmgmt.monitor
Class StateChangeEvent

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fc.Item
          extended bywt.projmgmt.monitor.ProjMgmtEvent
              extended bywt.projmgmt.monitor.StateChangeEvent
All Implemented Interfaces:
AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public class StateChangeEvent
extends ProjMgmtEvent
implements Externalizable

This class represents persistently change of state events. The states considered here are execution states (DEFINED, EXECUTING ...). A typical example would be the completion of a deliverable.

Use the newStateChangeEvent static factory method(s), not the StateChangeEvent 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:
ProjectState, Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
static String NEW_STATE
          Label for the attribute; New execution object state.
private static int NEW_STATE_UPPER_LIMIT
           
private  ProjectState newState
           
protected static long OLD_FORMAT_VERSION_UID
           
static String OLD_STATE
          Label for the attribute; Stores old execution object state.
private static int OLD_STATE_UPPER_LIMIT
           
private  ProjectState oldState
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.projmgmt.monitor.ProjMgmtEvent
CONTAINER, CREATOR_REF, EVENT_TIME, EVENT_TYPE, PLAN_REF, R60_EXTERNALIZATION_VERSION_UID, SOURCE, SOURCE_REFERENCE
 
Fields inherited from class wt.fc.Item
VERSION_40_UID, VERSION_51_UID
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.inf.container.WTContained
CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE
 
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.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
StateChangeEvent()
           
 
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.  
 ProjectState getNewState()
          Gets the value of the attribute: NEW_STATE.
 ProjectState getOldState()
          Gets the value of the attribute: OLD_STATE.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
static StateChangeEvent newStateChangeEvent()
          Default factory for the class.
 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(StateChangeEvent thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setNewState(ProjectState a_NewState)
          Sets the value of the attribute: NEW_STATE.
 void setOldState(ProjectState a_OldState)
          Sets the value of the attribute: OLD_STATE.
 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.projmgmt.monitor.ProjMgmtEvent
createProjMgmtEvent, getContainer, getContainerName, getContainerReference, getCreatorRef, getEventTime, getEventType, getPlanRef, getSource, getSourceReference, initialize, readVersion, setContainer, setContainerReference, setCreatorRef, setEventTime, setEventType, setPlanRef, setSource, setSourceReference
 
Methods inherited from class wt.fc.Item
getDomainRef, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain
 
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
 
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

OLD_STATE

public static final String OLD_STATE
Label for the attribute; Stores old execution object state.

Supported API: false

See Also:
Constant Field Values

OLD_STATE_UPPER_LIMIT

private static int OLD_STATE_UPPER_LIMIT

oldState

private ProjectState oldState

NEW_STATE

public static final String NEW_STATE
Label for the attribute; New execution object state.

Supported API: false

See Also:
Constant Field Values

NEW_STATE_UPPER_LIMIT

private static int NEW_STATE_UPPER_LIMIT

newState

private ProjectState newState

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

StateChangeEvent

public StateChangeEvent()
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 ProjMgmtEvent
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 ProjMgmtEvent
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

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

getOldState

public ProjectState getOldState()
Gets the value of the attribute: OLD_STATE. Stores old execution object state.

Supported API: false

Returns:
ProjectState

setOldState

public void setOldState(ProjectState a_OldState)
                 throws WTPropertyVetoException
Sets the value of the attribute: OLD_STATE. Stores old execution object state.

Supported API: false

Parameters:
a_OldState -
Throws:
WTPropertyVetoException

getNewState

public ProjectState getNewState()
Gets the value of the attribute: NEW_STATE. New execution object state.

Supported API: false

Returns:
ProjectState

setNewState

public void setNewState(ProjectState a_NewState)
                 throws WTPropertyVetoException
Sets the value of the attribute: NEW_STATE. New execution object state.

Supported API: false

Parameters:
a_NewState -
Throws:
WTPropertyVetoException

newStateChangeEvent

public static StateChangeEvent newStateChangeEvent()
                                            throws WTException
Default factory for the class.

Supported API: false

Returns:
StateChangeEvent
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 ProjMgmtEvent
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 ProjMgmtEvent
Returns:
int