wt.audit
Class LastAuditEvent

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

All Implemented Interfaces:

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

public class LastAuditEvent

extends Simple

implements Externalizable

Stores the last event associating a user and a target object. The reference to the target object may be null.

Use the newLastAuditEvent static factory method(s), not the LastAuditEvent 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	CLASSNAME
static String	EVENT_TIME Label for the attribute; Holds the time of the event's occurrence.
static String	EVENT_TYPE Label for the attribute; Contains the type of the event.
private static int	EVENT_TYPE_UPPER_LIMIT
private Timestamp	eventTime
private AuditEventType	eventType
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET_REFERENCE Label for the attribute; Reference to a persistable object.
private ObjectReference	targetReference
static String	USER_REFERENCE Label for the attribute; Reference to the user that caused the event.
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

LastAuditEvent()

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.
Timestamp	getEventTime() Gets the value of the attribute: EVENT_TIME.
AuditEventType	getEventType() Gets the value of the attribute: EVENT_TYPE.
ObjectReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
WTPrincipalReference	getUserReference() Gets the value of the attribute: USER_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static LastAuditEvent	newLastAuditEvent() 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(LastAuditEvent thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEventTime(Timestamp a_EventTime) Sets the value of the attribute: EVENT_TIME.
void	setEventType(AuditEventType a_EventType) Sets the value of the attribute: EVENT_TYPE.
void	setTargetReference(ObjectReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.
void	setUserReference(WTPrincipalReference a_UserReference) Sets the value of the attribute: USER_REFERENCE.
private void	targetReferenceValidate(ObjectReference a_TargetReference)
private void	userReferenceValidate(WTPrincipalReference a_UserReference)
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, toString

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_TYPE

public static final String EVENT_TYPE

Label for the attribute; Contains the type of the event.

Supported API: false

See Also:

Constant Field Values

EVENT_TYPE_UPPER_LIMIT

private static int EVENT_TYPE_UPPER_LIMIT

eventType

private AuditEventType eventType

EVENT_TIME

public static final String EVENT_TIME

Label for the attribute; Holds the time of the event's occurrence.

Supported API: false

See Also:

Constant Field Values

eventTime

private Timestamp eventTime

TARGET_REFERENCE

public static final String TARGET_REFERENCE

Label for the attribute; Reference to a persistable object. It may be null.

Supported API: false

See Also:

Constant Field Values

targetReference

private ObjectReference targetReference

USER_REFERENCE

public static final String USER_REFERENCE

Label for the attribute; Reference to the user that caused the event.

Supported API: false

See Also:

Constant Field Values

userReference

private WTPrincipalReference userReference

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

LastAuditEvent

public LastAuditEvent()

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

getEventType

public AuditEventType getEventType()

Gets the value of the attribute: EVENT_TYPE. Contains the type of the event.

Supported API: false

Returns:

AuditEventType

setEventType

public void setEventType(AuditEventType a_EventType)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_TYPE. Contains the type of the event.

Supported API: false

Parameters:

a_EventType -

Throws:

WTPropertyVetoException

getEventTime

public Timestamp getEventTime()

Gets the value of the attribute: EVENT_TIME. Holds the time of the event's occurrence.

Supported API: false

Returns:

Timestamp

setEventTime

public void setEventTime(Timestamp a_EventTime)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_TIME. Holds the time of the event's occurrence.

Supported API: false

Parameters:

a_EventTime -

Throws:

WTPropertyVetoException

getTargetReference

public ObjectReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE. Reference to a persistable object. It may be null.

Supported API: false

Returns:

ObjectReference

setTargetReference

public void setTargetReference(ObjectReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE. Reference to a persistable object. It may be null.

Supported API: false

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

targetReferenceValidate

private void targetReferenceValidate(ObjectReference a_TargetReference)
                              throws WTPropertyVetoException

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

getUserReference

public WTPrincipalReference getUserReference()

Gets the value of the attribute: USER_REFERENCE. Reference to the user that caused the event.

Supported API: false

Returns:

WTPrincipalReference

setUserReference

public void setUserReference(WTPrincipalReference a_UserReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: USER_REFERENCE. Reference to the user that caused the event.

Supported API: false

Parameters:

a_UserReference -

Throws:

WTPropertyVetoException

userReferenceValidate

private void userReferenceValidate(WTPrincipalReference a_UserReference)
                            throws WTPropertyVetoException

Parameters:

a_UserReference -

Throws:

WTPropertyVetoException

newLastAuditEvent

public static LastAuditEvent newLastAuditEvent()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

LastAuditEvent

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