wt.audit.eventinfo
Class AdHocEventInfo

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.audit.eventinfo.AdHocEventInfo

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, EventInfo, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class AdHocEventInfo

extends Item

implements EventInfo, Externalizable

Use the newAdHocEventInfo static factory method(s), not the AdHocEventInfo 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 Label for the attribute.
private ObjectReference	eventReference
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	PERMISSION_MASK Label for the attribute.
private long	permissionMask
static String	PRINCIPAL_DN Label for the attribute; Distinguished name of the principal.
private static int	PRINCIPAL_DN_UPPER_LIMIT
static String	PRINCIPAL_NAME Label for the attribute.
private static int	PRINCIPAL_NAME_UPPER_LIMIT
static String	PRINCIPAL_REF Label for the attribute.
private String	principalDn
private String	principalName
private WTPrincipalReference	principalRef
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	sign
static String	SIGN Label for the attribute.
private static int	SIGN_UPPER_LIMIT

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.audit.eventinfo.EventInfo

EVENT_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

AdHocEventInfo()

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.
private void	eventReferenceValidate(ObjectReference a_EventReference)
String	getConceptualClassname() Deprecated.
ProjectAuditEvent	getEvent() Gets the object for the association that plays role: EVENT.
ObjectReference	getEventReference() Gets the value of the attribute: EVENT_REFERENCE.
String	getIdString(ObjectReference ref)
long	getPermissionMask() Gets the value of the attribute: PERMISSION_MASK.
String	getPrincipalDn() Gets the value of the attribute: PRINCIPAL_DN.
String	getPrincipalName() Gets the value of the attribute: PRINCIPAL_NAME.
WTPrincipalReference	getPrincipalRef() Gets the value of the attribute: PRINCIPAL_REF.
String	getSign() Gets the value of the attribute: SIGN.
String	getString(Object obj)
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
static AdHocEventInfo	newAdHocEventInfo() Default factory for the class.
private void	principalDnValidate(String a_PrincipalDn)
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(AdHocEventInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEvent(ProjectAuditEvent a_Event) Sets the object for the association that plays role: EVENT.
void	setEventReference(ObjectReference a_EventReference) Sets the value of the attribute: EVENT_REFERENCE.
void	setPermissionMask(long a_PermissionMask) Sets the value of the attribute: PERMISSION_MASK.
void	setPrincipalDn(String a_PrincipalDn) Sets the value of the attribute: PRINCIPAL_DN.
void	setPrincipalName(String a_PrincipalName) Sets the value of the attribute: PRINCIPAL_NAME.
void	setPrincipalRef(WTPrincipalReference a_PrincipalRef) Sets the value of the attribute: PRINCIPAL_REF.
void	setSign(String a_Sign) Sets the value of the attribute: SIGN.
String	toString() Supported API: false
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

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

PRINCIPAL_REF

public static final String PRINCIPAL_REF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

principalRef

private WTPrincipalReference principalRef

PRINCIPAL_NAME

public static final String PRINCIPAL_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PRINCIPAL_NAME_UPPER_LIMIT

private static int PRINCIPAL_NAME_UPPER_LIMIT

principalName

private String principalName

PRINCIPAL_DN

public static final String PRINCIPAL_DN

Label for the attribute; Distinguished name of the principal.

Supported API: false

See Also:

Constant Field Values

PRINCIPAL_DN_UPPER_LIMIT

private static int PRINCIPAL_DN_UPPER_LIMIT

principalDn

private String principalDn

SIGN

public static final String SIGN

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SIGN_UPPER_LIMIT

private static int SIGN_UPPER_LIMIT

sign

private String sign

PERMISSION_MASK

public static final String PERMISSION_MASK

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

permissionMask

private long permissionMask

EVENT

public static final String EVENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

eventReference

private ObjectReference eventReference

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

AdHocEventInfo

public AdHocEventInfo()

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

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getPrincipalRef

public WTPrincipalReference getPrincipalRef()

Gets the value of the attribute: PRINCIPAL_REF.

Supported API: false

Returns:

WTPrincipalReference

setPrincipalRef

public void setPrincipalRef(WTPrincipalReference a_PrincipalRef)

Sets the value of the attribute: PRINCIPAL_REF.

Supported API: false

Parameters:

a_PrincipalRef -

getPrincipalName

public String getPrincipalName()

Gets the value of the attribute: PRINCIPAL_NAME.

Supported API: false

Returns:

String

setPrincipalName

public void setPrincipalName(String a_PrincipalName)

Sets the value of the attribute: PRINCIPAL_NAME.

Supported API: false

Parameters:

a_PrincipalName -

getPrincipalDn

public String getPrincipalDn()

Gets the value of the attribute: PRINCIPAL_DN. Distinguished name of the principal.

Supported API: false

Returns:

String

setPrincipalDn

public void setPrincipalDn(String a_PrincipalDn)
                    throws WTPropertyVetoException

Sets the value of the attribute: PRINCIPAL_DN. Distinguished name of the principal.

Supported API: false

Parameters:

a_PrincipalDn -

Throws:

WTPropertyVetoException

principalDnValidate

private void principalDnValidate(String a_PrincipalDn)
                          throws WTPropertyVetoException

Parameters:

a_PrincipalDn -

Throws:

WTPropertyVetoException

getSign

public String getSign()

Gets the value of the attribute: SIGN.

Supported API: false

Returns:

String

setSign

public void setSign(String a_Sign)

Sets the value of the attribute: SIGN.

Supported API: false

Parameters:

a_Sign -

getPermissionMask

public long getPermissionMask()

Gets the value of the attribute: PERMISSION_MASK.

Supported API: false

Returns:

long

setPermissionMask

public void setPermissionMask(long a_PermissionMask)

Sets the value of the attribute: PERMISSION_MASK.

Supported API: false

Parameters:

a_PermissionMask -

toString

public String toString()

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

newAdHocEventInfo

public static AdHocEventInfo newAdHocEventInfo()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

AdHocEventInfo

Throws:

WTException

getEvent

public ProjectAuditEvent getEvent()

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

Supported API: false

Specified by:

getEvent in interface EventInfo

Returns:

ProjectAuditEvent

setEvent

public void setEvent(ProjectAuditEvent a_Event)
              throws WTPropertyVetoException,
                     WTException

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

Supported API: false

Specified by:

setEvent in interface EventInfo

Parameters:

a_Event -

Throws:

WTPropertyVetoException

WTException

getEventReference

public ObjectReference getEventReference()

Gets the value of the attribute: EVENT_REFERENCE.

Supported API: false

Specified by:

getEventReference in interface EventInfo

Returns:

ObjectReference

setEventReference

public void setEventReference(ObjectReference a_EventReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: EVENT_REFERENCE.

Supported API: false

Specified by:

setEventReference in interface EventInfo

Parameters:

a_EventReference -

Throws:

WTPropertyVetoException

eventReferenceValidate

private void eventReferenceValidate(ObjectReference a_EventReference)
                             throws WTPropertyVetoException

Parameters:

a_EventReference -

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

getIdString

public String getIdString(ObjectReference ref)

getString

public String getString(Object obj)