com.ptc.windchill.esi.txn
Class ReleaseActivity

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          com.ptc.windchill.esi.txn.ReleaseActivity

All Implemented Interfaces:

BinaryLink, DisplayIdentification, ESITargetAssociation, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public class ReleaseActivity

extends ObjectToObjectLink

implements ESITargetAssociation, Externalizable

A record of a unit of work in an external system

Use the newReleaseActivity static factory method(s), not the ReleaseActivity 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: true

Extendable: true

See Also:

Serialized Form

Field Summary

private ReleaseActivityAction	action
static String	ACTION Label for the attribute.
private static int	ACTION_UPPER_LIMIT
private static String	BOM_CLASS
private static String	CLASSNAME
private String	creator
static String	CREATOR Label for the attribute; The name of the user who created this entry.
private static int	CREATOR_UPPER_LIMIT
private boolean	deleted
static String	DELETED Label for the attribute.
private String	description
static String	DESCRIPTION Label for the attribute; Helpful display information for RPC results, should be the logical class of the object Supported API: true
private static int	DESCRIPTION_UPPER_LIMIT
private static String	ESIRESOURCE
static long	EXTERNALIZATION_VERSION_UID
static String	MESSAGE Label for the attribute.
static String	MESSAGE_REFERENCE Label for the attribute.
private ObjectReference	messageReference
protected static long	OLD_FORMAT_VERSION_UID
static String	PERSISTABLE_OBJECT_ROLE Deprecated. , replaced by RELEASABLE_OBJECT_ROLE
static String	RELEASABLE_OBJECT_ROLE Label for the attribute.
static String	RELEASE_CLASS Label for the attribute.
private static int	RELEASE_CLASS_UPPER_LIMIT
static String	RELEASE_STAMP Label for the attribute; Timestamp of the release.
private String	releaseClass
private Timestamp	releaseStamp
private static String	RESOURCE
(package private) static long	serialVersionUID
private ReleaseStatusType	status
static String	STATUS Label for the attribute.
private static int	STATUS_UPPER_LIMIT
static String	TARGET_ROLE Label for the attribute.

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

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

ReleaseActivity()

Method Summary

private void	actionValidate(ReleaseActivityAction a_Action)
private void	creatorValidate(String a_Creator)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ReleaseActivityAction	getAction() Gets the object for the association that plays role: ACTION.
String	getConceptualClassname() Deprecated.
String	getCreator() Gets the value of the attribute: CREATOR.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
ReleaseActivityMessage	getMessage() Gets the object for the association that plays role: MESSAGE.
ObjectReference	getMessageReference() Gets the value of the attribute: MESSAGE_REFERENCE.
Persistable	getObject() returns the RoleA object Supported API: false
String	getObjectID()
String	getObjectName() If the persistable object implements getDisplayIdentifier() Supported API: false
Persistable	getPersistableObject() Returns the roleA object.
Releasable	getReleasableObject() Gets the object for the association that plays role: RELEASABLE_OBJECT_ROLE.
String	getReleaseClass() Gets the value of the attribute: RELEASE_CLASS.
Timestamp	getReleaseStamp() Gets the value of the attribute: RELEASE_STAMP.
ReleaseStatusType	getStatus() Gets the object for the association that plays role: STATUS.
ESITarget	getTarget() Gets the object for the association that plays role: TARGET_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isBOM() Returns true if releaseClass value matches the value specified in ESI properties.
boolean	isDeleted() Gets the value of the attribute: DELETED.
private void	messageReferenceValidate(ObjectReference a_MessageReference)
static ReleaseActivity	newReleaseActivity(Persistable persistableObject, ESITarget target) Deprecated. , replaced by ReleaseActivity newReleaseActivity( Releasable releasableObject, ESITarget target )
static ReleaseActivity	newReleaseActivity(Releasable releasableObject, ESITarget target) 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(ReleaseActivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	releaseClassValidate(String a_ReleaseClass)
void	setAction(ReleaseActivityAction a_Action) Sets the object for the association that plays role: ACTION.
void	setCreator(String a_Creator) Sets the value of the attribute: CREATOR.
void	setDeleted(boolean a_Deleted) Sets the value of the attribute: DELETED.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setMessage(ReleaseActivityMessage a_Message) Sets the object for the association that plays role: MESSAGE.
void	setMessageReference(ObjectReference a_MessageReference) Sets the value of the attribute: MESSAGE_REFERENCE.
(package private) void	setObject(Persistable object) Sets the ObjectToObjectLink roleA object Supported API: false
void	setPersistableObject(Persistable persistableObject) Deprecated. , replaced by setReleasableObject
void	setReleasableObject(Releasable releasableObject) Sets the object for the association that plays role: RELEASABLE_OBJECT_ROLE.
void	setReleaseClass(String a_ReleaseClass) Sets the value of the attribute: RELEASE_CLASS.
void	setReleaseStamp(Timestamp a_ReleaseStamp) Sets the value of the attribute: RELEASE_STAMP.
void	setStatus(ReleaseStatusType a_Status) Sets the object for the association that plays role: STATUS.
void	setTarget(ESITarget target) Sets the object for the association that plays role: TARGET_ROLE.
private void	statusValidate(ReleaseStatusType a_Status)
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.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, 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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

RELEASABLE_OBJECT_ROLE

public static final String RELEASABLE_OBJECT_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

TARGET_ROLE

public static final String TARGET_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

RELEASE_STAMP

public static final String RELEASE_STAMP

Label for the attribute; Timestamp of the release.

Supported API: true

See Also:

Constant Field Values

releaseStamp

private Timestamp releaseStamp

CREATOR

public static final String CREATOR

Label for the attribute; The name of the user who created this entry.

Supported API: true

See Also:

Constant Field Values

CREATOR_UPPER_LIMIT

private static int CREATOR_UPPER_LIMIT

creator

private String creator

DELETED

public static final String DELETED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

deleted

private boolean deleted

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Helpful display information for RPC results, should be the logical class of the object

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

RELEASE_CLASS

public static final String RELEASE_CLASS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

RELEASE_CLASS_UPPER_LIMIT

private static int RELEASE_CLASS_UPPER_LIMIT

releaseClass

private String releaseClass

MESSAGE

public static final String MESSAGE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MESSAGE_REFERENCE

public static final String MESSAGE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

messageReference

private ObjectReference messageReference

STATUS

public static final String STATUS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

STATUS_UPPER_LIMIT

private static int STATUS_UPPER_LIMIT

status

private ReleaseStatusType status

ACTION

public static final String ACTION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

ACTION_UPPER_LIMIT

private static int ACTION_UPPER_LIMIT

action

private ReleaseActivityAction action

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

ESIRESOURCE

private static final String ESIRESOURCE

See Also:

Constant Field Values

BOM_CLASS

private static final String BOM_CLASS

PERSISTABLE_OBJECT_ROLE

public static final String PERSISTABLE_OBJECT_ROLE

Deprecated. , replaced by RELEASABLE_OBJECT_ROLE

Supported API: false

See Also:

Constant Field Values

Constructor Detail

ReleaseActivity

public ReleaseActivity()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getReleasableObject

public Releasable getReleasableObject()

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

Supported API: true

Returns:

Releasable

setReleasableObject

public void setReleasableObject(Releasable releasableObject)
                         throws WTPropertyVetoException

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

Supported API: true

Parameters:

releasableObject -

Throws:

WTPropertyVetoException

getTarget

public ESITarget getTarget()

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

Supported API: true

Specified by:

getTarget in interface ESITargetAssociation

Returns:

ESITarget

setTarget

public void setTarget(ESITarget target)
               throws WTPropertyVetoException

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

Supported API: true

Parameters:

target -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getReleaseStamp

public Timestamp getReleaseStamp()

Gets the value of the attribute: RELEASE_STAMP. Timestamp of the release.

Supported API: true

Returns:

Timestamp

setReleaseStamp

public void setReleaseStamp(Timestamp a_ReleaseStamp)
                     throws WTPropertyVetoException

Sets the value of the attribute: RELEASE_STAMP. Timestamp of the release.

Supported API: true

Parameters:

a_ReleaseStamp -

Throws:

WTPropertyVetoException

getCreator

public String getCreator()

Gets the value of the attribute: CREATOR. The name of the user who created this entry.

Supported API: true

Returns:

String

setCreator

public void setCreator(String a_Creator)
                throws WTPropertyVetoException

Sets the value of the attribute: CREATOR. The name of the user who created this entry.

Supported API: true

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(String a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

isDeleted

public boolean isDeleted()

Gets the value of the attribute: DELETED.

Supported API: true

Returns:

boolean

setDeleted

public void setDeleted(boolean a_Deleted)
                throws WTPropertyVetoException

Sets the value of the attribute: DELETED.

Supported API: true

Parameters:

a_Deleted -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Helpful display information for RPC results, should be the logical class of the object

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Helpful display information for RPC results, should be the logical class of the object

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getReleaseClass

public String getReleaseClass()

Gets the value of the attribute: RELEASE_CLASS.

Supported API: true

Returns:

String

setReleaseClass

public void setReleaseClass(String a_ReleaseClass)
                     throws WTPropertyVetoException

Sets the value of the attribute: RELEASE_CLASS.

Supported API: true

Parameters:

a_ReleaseClass -

Throws:

WTPropertyVetoException

releaseClassValidate

private void releaseClassValidate(String a_ReleaseClass)
                           throws WTPropertyVetoException

Parameters:

a_ReleaseClass -

Throws:

WTPropertyVetoException

getMessage

public ReleaseActivityMessage getMessage()

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

Supported API: false

Returns:

ReleaseActivityMessage

setMessage

public void setMessage(ReleaseActivityMessage a_Message)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Parameters:

a_Message -

Throws:

WTPropertyVetoException

WTException

getMessageReference

public ObjectReference getMessageReference()

Gets the value of the attribute: MESSAGE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setMessageReference

public void setMessageReference(ObjectReference a_MessageReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: MESSAGE_REFERENCE.

Supported API: false

Parameters:

a_MessageReference -

Throws:

WTPropertyVetoException

messageReferenceValidate

private void messageReferenceValidate(ObjectReference a_MessageReference)
                               throws WTPropertyVetoException

Parameters:

a_MessageReference -

Throws:

WTPropertyVetoException

getStatus

public ReleaseStatusType getStatus()

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

Supported API: true

Returns:

ReleaseStatusType

setStatus

public void setStatus(ReleaseStatusType a_Status)
               throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Status -

Throws:

WTPropertyVetoException

statusValidate

private void statusValidate(ReleaseStatusType a_Status)
                     throws WTPropertyVetoException

Parameters:

a_Status -

Throws:

WTPropertyVetoException

getAction

public ReleaseActivityAction getAction()

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

Supported API: true

Returns:

ReleaseActivityAction

setAction

public void setAction(ReleaseActivityAction a_Action)
               throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Action -

Throws:

WTPropertyVetoException

actionValidate

private void actionValidate(ReleaseActivityAction a_Action)
                     throws WTPropertyVetoException

Parameters:

a_Action -

Throws:

WTPropertyVetoException

getObject

public Persistable getObject()

returns the RoleA object

Supported API: false

Returns:

Persistable

getObjectName

public String getObjectName()

If the persistable object implements getDisplayIdentifier()

Supported API: false

Returns:

String

getPersistableObject

public Persistable getPersistableObject()

Returns the roleA object. Necessary for ReleaseActivity to implement ESITargetAssociation interface.

Supported API: false

Specified by:

getPersistableObject in interface ESITargetAssociation

Returns:

Persistable

isBOM

public boolean isBOM()

Returns true if releaseClass value matches the value specified in ESI properties.

Supported API: false

Returns:

boolean

setObject

void setObject(Persistable object)
         throws WTException

Sets the ObjectToObjectLink roleA object

Supported API: false

Parameters:

object -

Throws:

WTException

newReleaseActivity

public static ReleaseActivity newReleaseActivity(Releasable releasableObject,
                                                 ESITarget target)
                                          throws WTException

Default factory for the class.

Supported API: false

Parameters:

releasableObject -

target -

Returns:

ReleaseActivity

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

getObjectID

public String getObjectID()
                   throws WTException

Throws:

WTException

setPersistableObject

public void setPersistableObject(Persistable persistableObject)

Deprecated. , replaced by setReleasableObject

Supported API: false

newReleaseActivity

public static ReleaseActivity newReleaseActivity(Persistable persistableObject,
                                                 ESITarget target)
                                          throws WTException

Deprecated. , replaced by ReleaseActivity newReleaseActivity( Releasable releasableObject, ESITarget target )

Supported API: false

Throws:

WTException