wt.eff
Class EffChangeAudit

java.lang.Object
  wt.eff.EffChangeAudit

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EffChangeAudit

extends Object

implements Persistable, Externalizable

Object that marks the creation or factual deletion of an Eff object.

Use the newEffChangeAudit static factory method(s), not the EffChangeAudit 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

static String	AUTHORIZED_BY Label for the attribute.
static String	AUTHORIZED_BY_REFERENCE Label for the attribute.
private ObjectReference	authorizedByReference
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	MODIFIER Label for the attribute.
static String	MODIFIER_REFERENCE Label for the attribute.
private ObjectReference	modifierReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EffChangeAudit()

Method Summary

private void	authorizedByReferenceValidate(ObjectReference a_AuthorizedByReference)
void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ChangeActivityIfc	getAuthorizedBy() Gets the object for the association that plays role: AUTHORIZED_BY.
ObjectReference	getAuthorizedByReference() Gets the value of the attribute: AUTHORIZED_BY_REFERENCE.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
WTPrincipal	getModifier() Gets the object for the association that plays role: MODIFIER.
ObjectReference	getModifierReference() Gets the value of the attribute: MODIFIER_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(ChangeActivityIfc a_ChangeActivityIfc) Supports initialization, following construction of an instance.
private void	modifierReferenceValidate(ObjectReference a_ModifierReference)
static EffChangeAudit	newEffChangeAudit(ChangeActivityIfc a_ChangeActivityIfc) Supported API: false
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(EffChangeAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAuthorizedBy(ChangeActivityIfc a_AuthorizedBy) Sets the object for the association that plays role: AUTHORIZED_BY.
void	setAuthorizedByReference(ObjectReference a_AuthorizedByReference) Sets the value of the attribute: AUTHORIZED_BY_REFERENCE.
void	setModifier(WTPrincipal a_Modifier) Sets the object for the association that plays role: MODIFIER.
void	setModifierReference(ObjectReference a_ModifierReference) Sets the value of the attribute: MODIFIER_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

MODIFIER

public static final String MODIFIER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MODIFIER_REFERENCE

public static final String MODIFIER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

modifierReference

private ObjectReference modifierReference

AUTHORIZED_BY

public static final String AUTHORIZED_BY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

AUTHORIZED_BY_REFERENCE

public static final String AUTHORIZED_BY_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

authorizedByReference

private ObjectReference authorizedByReference

thePersistInfo

private PersistInfo thePersistInfo

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

EffChangeAudit

public EffChangeAudit()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getModifier

public WTPrincipal getModifier()

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

Supported API: false

Returns:

WTPrincipal

setModifier

public void setModifier(WTPrincipal a_Modifier)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Modifier -

Throws:

WTPropertyVetoException

WTException

getModifierReference

public ObjectReference getModifierReference()

Gets the value of the attribute: MODIFIER_REFERENCE.

Supported API: false

Returns:

ObjectReference

setModifierReference

public void setModifierReference(ObjectReference a_ModifierReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: MODIFIER_REFERENCE.

Supported API: false

Parameters:

a_ModifierReference -

Throws:

WTPropertyVetoException

modifierReferenceValidate

private void modifierReferenceValidate(ObjectReference a_ModifierReference)
                                throws WTPropertyVetoException

Parameters:

a_ModifierReference -

Throws:

WTPropertyVetoException

getAuthorizedBy

public ChangeActivityIfc getAuthorizedBy()

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

Supported API: false

Returns:

ChangeActivityIfc

setAuthorizedBy

public void setAuthorizedBy(ChangeActivityIfc a_AuthorizedBy)
                     throws WTPropertyVetoException,
                            WTException

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

Supported API: false

Parameters:

a_AuthorizedBy -

Throws:

WTPropertyVetoException

WTException

getAuthorizedByReference

public ObjectReference getAuthorizedByReference()

Gets the value of the attribute: AUTHORIZED_BY_REFERENCE.

Supported API: false

Returns:

ObjectReference

setAuthorizedByReference

public void setAuthorizedByReference(ObjectReference a_AuthorizedByReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: AUTHORIZED_BY_REFERENCE.

Supported API: false

Parameters:

a_AuthorizedByReference -

Throws:

WTPropertyVetoException

authorizedByReferenceValidate

private void authorizedByReferenceValidate(ObjectReference a_AuthorizedByReference)
                                    throws WTPropertyVetoException

Parameters:

a_AuthorizedByReference -

Throws:

WTPropertyVetoException

newEffChangeAudit

public static EffChangeAudit newEffChangeAudit(ChangeActivityIfc a_ChangeActivityIfc)
                                        throws WTException,
                                               WTPropertyVetoException

Supported API: false

Parameters:

a_ChangeActivityIfc -

Returns:

EffChangeAudit

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(ChangeActivityIfc a_ChangeActivityIfc)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

a_ChangeActivityIfc -

Throws:

WTException

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int