wt.projmgmt.monitor
Class ProjMgmtEvent

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.projmgmt.monitor.ProjMgmtEvent

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

Direct Known Subclasses:

DeadlineChangeEvent, DeadlineEvent, ObjectDeletionEvent, OwnerChangeEvent, StateChangeEvent, StatusChangeEvent

public abstract class ProjMgmtEvent

extends Item

implements WTContained, Externalizable

ProjMgmtEvent represents in the database individual events that constitute the "project history."

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
static String	CREATOR_REF Label for the attribute; Reference to the user responsible for the action that created the event.
private WTPrincipalReference	creatorRef
static String	EVENT_TIME Label for the attribute; Time of the occurrence of the event.
static String	EVENT_TYPE Label for the attribute; Type of the event.
private static int	EVENT_TYPE_UPPER_LIMIT
private Timestamp	eventTime
private ProjectEventType	eventType
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	PLAN_REF Label for the attribute; Reference to the project plan to which the execution object belongs.
private ObjectReference	planRef
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SOURCE Label for the attribute.
static String	SOURCE_REFERENCE Label for the attribute.
private ObjectReference	sourceReference

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

ProjMgmtEvent()

Method Summary

private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
static ProjMgmtEvent	createProjMgmtEvent(ProjectEventType event_type, ExecutionObject source, Timestamp event_time, Object old_val) Project management event factory.
private void	creatorRefValidate(WTPrincipalReference a_CreatorRef)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
WTPrincipalReference	getCreatorRef() Gets the value of the attribute: CREATOR_REF.
Timestamp	getEventTime() Gets the value of the attribute: EVENT_TIME.
ProjectEventType	getEventType() Gets the value of the attribute: EVENT_TYPE.
ObjectReference	getPlanRef() Gets the value of the attribute: PLAN_REF.
ExecutionObject	getSource() Gets the object for the association that plays role: SOURCE.
ObjectReference	getSourceReference() Gets the value of the attribute: SOURCE_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
private void	planRefValidate(ObjectReference a_PlanRef)
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(ProjMgmtEvent thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setCreatorRef(WTPrincipalReference a_CreatorRef) Sets the value of the attribute: CREATOR_REF.
void	setEventTime(Timestamp a_EventTime) Sets the value of the attribute: EVENT_TIME.
void	setEventType(ProjectEventType a_EventType) Sets the value of the attribute: EVENT_TYPE.
void	setPlanRef(ObjectReference a_PlanRef) Sets the value of the attribute: PLAN_REF.
void	setSource(ExecutionObject a_Source) Sets the object for the association that plays role: SOURCE.
void	setSourceReference(ObjectReference a_SourceReference) Sets the value of the attribute: SOURCE_REFERENCE.
private void	sourceReferenceValidate(ObjectReference a_SourceReference)
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.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, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

EVENT_TYPE

public static final String EVENT_TYPE

Label for the attribute; Type of the event. Except for deadline, time to deadline and time past deadline that are in a single table, each type has it own table.

Supported API: false

See Also:

Constant Field Values

EVENT_TYPE_UPPER_LIMIT

private static int EVENT_TYPE_UPPER_LIMIT

eventType

private ProjectEventType eventType

EVENT_TIME

public static final String EVENT_TIME

Label for the attribute; Time of the occurrence of the event.

Supported API: false

See Also:

Constant Field Values

eventTime

private Timestamp eventTime

PLAN_REF

public static final String PLAN_REF

Label for the attribute; Reference to the project plan to which the execution object belongs. This is a kind of redundant attribute but it is handy for searchs.

Supported API: false

See Also:

Constant Field Values

planRef

private ObjectReference planRef

CREATOR_REF

public static final String CREATOR_REF

Label for the attribute; Reference to the user responsible for the action that created the event.

Supported API: false

See Also:

Constant Field Values

creatorRef

private WTPrincipalReference creatorRef

SOURCE

public static final String SOURCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SOURCE_REFERENCE

public static final String SOURCE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

sourceReference

private ObjectReference sourceReference

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

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

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ProjMgmtEvent

public ProjMgmtEvent()

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 Item

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 Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Item

Parameters:

input -

Throws:

SQLException

DatastoreException

getEventType

public ProjectEventType getEventType()

Gets the value of the attribute: EVENT_TYPE. Type of the event. Except for deadline, time to deadline and time past deadline that are in a single table, each type has it own table.

Supported API: false

Returns:

ProjectEventType

setEventType

public void setEventType(ProjectEventType a_EventType)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_TYPE. Type of the event. Except for deadline, time to deadline and time past deadline that are in a single table, each type has it own table.

Supported API: false

Parameters:

a_EventType -

Throws:

WTPropertyVetoException

getEventTime

public Timestamp getEventTime()

Gets the value of the attribute: EVENT_TIME. Time of the occurrence of the event.

Supported API: false

Returns:

Timestamp

setEventTime

public void setEventTime(Timestamp a_EventTime)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_TIME. Time of the occurrence of the event.

Supported API: false

Parameters:

a_EventTime -

Throws:

WTPropertyVetoException

getPlanRef

public ObjectReference getPlanRef()

Gets the value of the attribute: PLAN_REF. Reference to the project plan to which the execution object belongs. This is a kind of redundant attribute but it is handy for searchs.

Supported API: false

Returns:

ObjectReference

setPlanRef

public void setPlanRef(ObjectReference a_PlanRef)
                throws WTPropertyVetoException

Sets the value of the attribute: PLAN_REF. Reference to the project plan to which the execution object belongs. This is a kind of redundant attribute but it is handy for searchs.

Supported API: false

Parameters:

a_PlanRef -

Throws:

WTPropertyVetoException

planRefValidate

private void planRefValidate(ObjectReference a_PlanRef)
                      throws WTPropertyVetoException

Parameters:

a_PlanRef -

Throws:

WTPropertyVetoException

getCreatorRef

public WTPrincipalReference getCreatorRef()

Gets the value of the attribute: CREATOR_REF. Reference to the user responsible for the action that created the event.

Supported API: false

Returns:

WTPrincipalReference

setCreatorRef

public void setCreatorRef(WTPrincipalReference a_CreatorRef)
                   throws WTPropertyVetoException

Sets the value of the attribute: CREATOR_REF. Reference to the user responsible for the action that created the event.

Supported API: false

Parameters:

a_CreatorRef -

Throws:

WTPropertyVetoException

creatorRefValidate

private void creatorRefValidate(WTPrincipalReference a_CreatorRef)
                         throws WTPropertyVetoException

Parameters:

a_CreatorRef -

Throws:

WTPropertyVetoException

getSource

public ExecutionObject getSource()

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

Supported API: false

Returns:

ExecutionObject

setSource

public void setSource(ExecutionObject a_Source)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Source -

Throws:

WTPropertyVetoException

WTException

getSourceReference

public ObjectReference getSourceReference()

Gets the value of the attribute: SOURCE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setSourceReference

public void setSourceReference(ObjectReference a_SourceReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: SOURCE_REFERENCE.

Supported API: false

Parameters:

a_SourceReference -

Throws:

WTPropertyVetoException

sourceReferenceValidate

private void sourceReferenceValidate(ObjectReference a_SourceReference)
                              throws WTPropertyVetoException

Parameters:

a_SourceReference -

Throws:

WTPropertyVetoException

createProjMgmtEvent

public static ProjMgmtEvent createProjMgmtEvent(ProjectEventType event_type,
                                                ExecutionObject source,
                                                Timestamp event_time,
                                                Object old_val)
                                         throws WTException

Project management event factory. Returns a transient object event.

Supported API: false

Parameters:

event_type -

source -

event_time -

old_val -

Returns:

ProjMgmtEvent

Throws:

WTException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

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 Item

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 Item

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Item

Supported API: false

Overrides:

initialize in class Item

Throws:

WTException