wt.audit
Class ProjectAuditEvent

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.audit.ProjectAuditEvent

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class ProjectAuditEvent

extends Simple

implements Externalizable

Auditing event generated in the context of a project.

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

Serialized Form

Field Summary

private static String	BUNDLE_NAME
private static String	CLASSNAME
static String	EVENT_KEY Label for the attribute; Event key.
private static int	EVENT_KEY_UPPER_LIMIT
static String	EVENT_TIME Label for the attribute; Time of the event.
private String	eventKey
private Timestamp	eventTime
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	ORG_REFERENCE Label for the attribute; Reference to the organization that hosts the project that owns the object that is source of the event.
private ObjectReference	orgReference
static String	PROJECT Label for the attribute.
static String	PROJECT_REFERENCE Label for the attribute.
private ObjectReference	projectReference
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET_NAME Label for the attribute; Name of the target object.
private static int	TARGET_NAME_UPPER_LIMIT
static String	TARGET_REFERENCE Label for the attribute; Refence to Windchill object that is the target of the event.
private String	targetName
private ObjectReference	targetReference
static String	USER_ORG_NAME Label for the attribute; Organization the current user belongs at the time the event was emitted.
private static int	USER_ORG_NAME_UPPER_LIMIT
static String	USER_REFERENCE Label for the attribute; Reference to the user that is the current principal when the event happened.
private String	userOrgName
private WTPrincipalReference	userReference

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ProjectAuditEvent()

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.
String	getDisplayValue() Supported API: false
String	getEventKey() Gets the value of the attribute: EVENT_KEY.
static QueryResult	getEventKeys() Returns a list of valid event types.
Timestamp	getEventTime() Gets the value of the attribute: EVENT_TIME.
String	getEventType(String event_key)
static long	getId(Persistable obj)
static ObjectIdentifier	getOid(Object obj)
static String	getOidString(Object obj)
ObjectReference	getOrgReference() Gets the value of the attribute: ORG_REFERENCE.
WTContainer	getProject() Gets the object for the association that plays role: PROJECT.
ObjectReference	getProjectReference() Gets the value of the attribute: PROJECT_REFERENCE.
String	getTargetName() Gets the value of the attribute: TARGET_NAME.
ObjectReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
String	getUserOrgName() Gets the value of the attribute: USER_ORG_NAME.
WTPrincipalReference	getUserReference() Gets the value of the attribute: USER_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static boolean	isValidKey(String event_key) Determines whether a String passed as argument is a valid event type.
static ProjectAuditEvent	newProjectAuditEvent() Default factory for the class.
private void	projectReferenceValidate(ObjectReference a_ProjectReference)
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(ProjectAuditEvent thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEventKey(String a_EventKey) Sets the value of the attribute: EVENT_KEY.
void	setEventTime(Timestamp a_EventTime) Sets the value of the attribute: EVENT_TIME.
void	setOrgReference(ObjectReference a_OrgReference) Sets the value of the attribute: ORG_REFERENCE.
void	setProject(WTContainer a_Project) Sets the object for the association that plays role: PROJECT.
void	setProjectReference(ObjectReference a_ProjectReference) Sets the value of the attribute: PROJECT_REFERENCE.
void	setTargetName(String a_TargetName) Sets the value of the attribute: TARGET_NAME.
void	setTargetReference(ObjectReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.
void	setUserOrgName(String a_UserOrgName) Sets the value of the attribute: USER_ORG_NAME.
void	setUserReference(WTPrincipalReference a_UserReference) Sets the value of the attribute: USER_REFERENCE.
String	toString() Returns String representation of the event.
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, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

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

EVENT_KEY

public static final String EVENT_KEY

Label for the attribute; Event key. Every project audit event corresponds to a Windchill event (KeyedEvent). This attribute is the Windchill event key.

Supported API: false

See Also:

Constant Field Values

EVENT_KEY_UPPER_LIMIT

private static int EVENT_KEY_UPPER_LIMIT

eventKey

private String eventKey

EVENT_TIME

public static final String EVENT_TIME

Label for the attribute; Time of the event.

Supported API: false

See Also:

Constant Field Values

eventTime

private Timestamp eventTime

USER_REFERENCE

public static final String USER_REFERENCE

Label for the attribute; Reference to the user that is the current principal when the event happened.

Supported API: false

See Also:

Constant Field Values

userReference

private WTPrincipalReference userReference

USER_ORG_NAME

public static final String USER_ORG_NAME

Label for the attribute; Organization the current user belongs at the time the event was emitted.

Supported API: false

See Also:

Constant Field Values

USER_ORG_NAME_UPPER_LIMIT

private static int USER_ORG_NAME_UPPER_LIMIT

userOrgName

private String userOrgName

TARGET_NAME

public static final String TARGET_NAME

Label for the attribute; Name of the target object. If the target object is not named, this attribute is 'null.'

Supported API: false

See Also:

Constant Field Values

TARGET_NAME_UPPER_LIMIT

private static int TARGET_NAME_UPPER_LIMIT

targetName

private String targetName

TARGET_REFERENCE

public static final String TARGET_REFERENCE

Label for the attribute; Refence to Windchill object that is the target of the event.

Supported API: false

See Also:

Constant Field Values

targetReference

private ObjectReference targetReference

ORG_REFERENCE

public static final String ORG_REFERENCE

Label for the attribute; Reference to the organization that hosts the project that owns the object that is source of the event. This is attribute is 'null' if there is no project (i. e. the project container is an organization or there is no project container).

Supported API: false

See Also:

Constant Field Values

orgReference

private ObjectReference orgReference

PROJECT

public static final String PROJECT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PROJECT_REFERENCE

public static final String PROJECT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

projectReference

private ObjectReference projectReference

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

BUNDLE_NAME

private static final String BUNDLE_NAME

Constructor Detail

ProjectAuditEvent

public ProjectAuditEvent()

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

getEventKey

public String getEventKey()

Gets the value of the attribute: EVENT_KEY. Event key. Every project audit event corresponds to a Windchill event (KeyedEvent). This attribute is the Windchill event key.

Supported API: false

Returns:

String

setEventKey

public void setEventKey(String a_EventKey)

Sets the value of the attribute: EVENT_KEY. Event key. Every project audit event corresponds to a Windchill event (KeyedEvent). This attribute is the Windchill event key.

Supported API: false

Parameters:

a_EventKey -

getEventTime

public Timestamp getEventTime()

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

Supported API: false

Returns:

Timestamp

setEventTime

public void setEventTime(Timestamp a_EventTime)

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

Supported API: false

Parameters:

a_EventTime -

getUserReference

public WTPrincipalReference getUserReference()

Gets the value of the attribute: USER_REFERENCE. Reference to the user that is the current principal when the event happened.

Supported API: false

Returns:

WTPrincipalReference

setUserReference

public void setUserReference(WTPrincipalReference a_UserReference)

Sets the value of the attribute: USER_REFERENCE. Reference to the user that is the current principal when the event happened.

Supported API: false

Parameters:

a_UserReference -

getUserOrgName

public String getUserOrgName()

Gets the value of the attribute: USER_ORG_NAME. Organization the current user belongs at the time the event was emitted.

Supported API: false

Returns:

String

setUserOrgName

public void setUserOrgName(String a_UserOrgName)

Sets the value of the attribute: USER_ORG_NAME. Organization the current user belongs at the time the event was emitted.

Supported API: false

Parameters:

a_UserOrgName -

getTargetName

public String getTargetName()

Gets the value of the attribute: TARGET_NAME. Name of the target object. If the target object is not named, this attribute is 'null.'

Supported API: false

Returns:

String

setTargetName

public void setTargetName(String a_TargetName)

Sets the value of the attribute: TARGET_NAME. Name of the target object. If the target object is not named, this attribute is 'null.'

Supported API: false

Parameters:

a_TargetName -

getTargetReference

public ObjectReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE. Refence to Windchill object that is the target of the event.

Supported API: false

Returns:

ObjectReference

setTargetReference

public void setTargetReference(ObjectReference a_TargetReference)

Sets the value of the attribute: TARGET_REFERENCE. Refence to Windchill object that is the target of the event.

Supported API: false

Parameters:

a_TargetReference -

getOrgReference

public ObjectReference getOrgReference()

Gets the value of the attribute: ORG_REFERENCE. Reference to the organization that hosts the project that owns the object that is source of the event. This is attribute is 'null' if there is no project (i. e. the project container is an organization or there is no project container).

Supported API: false

Returns:

ObjectReference

setOrgReference

public void setOrgReference(ObjectReference a_OrgReference)

Sets the value of the attribute: ORG_REFERENCE. Reference to the organization that hosts the project that owns the object that is source of the event. This is attribute is 'null' if there is no project (i. e. the project container is an organization or there is no project container).

Supported API: false

Parameters:

a_OrgReference -

getProject

public WTContainer getProject()

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

Supported API: false

Returns:

WTContainer

setProject

public void setProject(WTContainer a_Project)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Parameters:

a_Project -

Throws:

WTPropertyVetoException

WTException

getProjectReference

public ObjectReference getProjectReference()

Gets the value of the attribute: PROJECT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setProjectReference

public void setProjectReference(ObjectReference a_ProjectReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: PROJECT_REFERENCE.

Supported API: false

Parameters:

a_ProjectReference -

Throws:

WTPropertyVetoException

projectReferenceValidate

private void projectReferenceValidate(ObjectReference a_ProjectReference)
                               throws WTPropertyVetoException

Parameters:

a_ProjectReference -

Throws:

WTPropertyVetoException

toString

public String toString()

Returns String representation of the event.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

getDisplayValue

public String getDisplayValue()

Supported API: false

Returns:

String

getEventKeys

public static QueryResult getEventKeys()
                                throws WTException

Returns a list of valid event types.

Supported API: false

Returns:

QueryResult

Throws:

WTException

isValidKey

public static boolean isValidKey(String event_key)

Determines whether a String passed as argument is a valid event type. Returns 'true' if this is the case; 'false' otherwise.

Supported API: false

Parameters:

event_key -

Returns:

boolean

newProjectAuditEvent

public static ProjectAuditEvent newProjectAuditEvent()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

ProjectAuditEvent

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

getOid

public static ObjectIdentifier getOid(Object obj)

getId

public static long getId(Persistable obj)

getOidString

public static String getOidString(Object obj)

getEventType

public String getEventType(String event_key)