com.ptc.windchill.esi.txn
Class ESITransaction

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          com.ptc.windchill.esi.txn.ESITransaction

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public class ESITransaction

extends Item

implements WTContained, Externalizable

Defines an ESI Transaction and manages a set of ReleaseActivities.

Use the newESITransaction static factory method(s), not the ESITransaction 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 static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
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.
static String	END_TIME_STAMP Label for the attribute; End timestamp of the transaction.
private Timestamp	endTimeStamp
static long	EXTERNALIZATION_VERSION_UID
static String	ID_NUMBER Label for the attribute.
private int	idNumber
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
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	START_TIME_STAMP Label for the attribute; Start timestamp of the transaction.
private Timestamp	startTimeStamp
private ESITransactionStatusType	status
static String	STATUS Label for the attribute.
private static int	STATUS_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.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_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

ESITransaction()

Method Summary

private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	creatorValidate(String a_Creator)
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.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
String	getCreator() Gets the value of the attribute: CREATOR.
Timestamp	getEndTimeStamp() Gets the value of the attribute: END_TIME_STAMP.
int	getIdNumber() Gets the value of the attribute: ID_NUMBER.
ESITransactionMessage	getMessage() Gets the object for the association that plays role: MESSAGE.
ObjectReference	getMessageReference() Gets the value of the attribute: MESSAGE_REFERENCE.
Timestamp	getStartTimeStamp() Gets the value of the attribute: START_TIME_STAMP.
ESITransactionStatusType	getStatus() Gets the object for the association that plays role: STATUS.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(ESITransactionMessage msg) Supports initialization, following construction of an instance.
boolean	isDeleted() Gets the value of the attribute: DELETED.
private void	messageReferenceValidate(ObjectReference a_MessageReference)
(package private) static ESITransaction	newESITransaction() Supported API: false
(package private) static ESITransaction	newESITransaction(ESITransactionMessage msg) Supported API: false
(package private) static ESITransaction	newESITransaction(String userName, int transactionId)
private static Timestamp	now()
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(ESITransaction thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
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	setEndTimeStamp(Timestamp a_EndTimeStamp) Sets the value of the attribute: END_TIME_STAMP.
void	setIdNumber(int a_IdNumber) Sets the value of the attribute: ID_NUMBER.
void	setMessage(ESITransactionMessage 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.
void	setStartTimeStamp(Timestamp a_StartTimeStamp) Sets the value of the attribute: START_TIME_STAMP.
void	setStatus(ESITransactionStatusType a_Status) Sets the object for the association that plays role: STATUS.
private void	statusValidate(ESITransactionStatusType 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.Item

getDomainRef, initialize, 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, 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

ID_NUMBER

public static final String ID_NUMBER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

idNumber

private int idNumber

DELETED

public static final String DELETED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

deleted

private boolean deleted

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

START_TIME_STAMP

public static final String START_TIME_STAMP

Label for the attribute; Start timestamp of the transaction.

Supported API: true

See Also:

Constant Field Values

startTimeStamp

private Timestamp startTimeStamp

END_TIME_STAMP

public static final String END_TIME_STAMP

Label for the attribute; End timestamp of the transaction.

Supported API: true

See Also:

Constant Field Values

endTimeStamp

private Timestamp endTimeStamp

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

MESSAGE

public static final String MESSAGE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

MESSAGE_REFERENCE

public static final String MESSAGE_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

messageReference

private ObjectReference messageReference

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

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

ESITransaction

public ESITransaction()

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

getIdNumber

public int getIdNumber()

Gets the value of the attribute: ID_NUMBER.

Supported API: true

Returns:

int

setIdNumber

public void setIdNumber(int a_IdNumber)
                 throws WTPropertyVetoException

Sets the value of the attribute: ID_NUMBER.

Supported API: true

Parameters:

a_IdNumber -

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

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

getStartTimeStamp

public Timestamp getStartTimeStamp()

Gets the value of the attribute: START_TIME_STAMP. Start timestamp of the transaction.

Supported API: true

Returns:

Timestamp

setStartTimeStamp

public void setStartTimeStamp(Timestamp a_StartTimeStamp)
                       throws WTPropertyVetoException

Sets the value of the attribute: START_TIME_STAMP. Start timestamp of the transaction.

Supported API: true

Parameters:

a_StartTimeStamp -

Throws:

WTPropertyVetoException

getEndTimeStamp

public Timestamp getEndTimeStamp()

Gets the value of the attribute: END_TIME_STAMP. End timestamp of the transaction.

Supported API: true

Returns:

Timestamp

setEndTimeStamp

public void setEndTimeStamp(Timestamp a_EndTimeStamp)
                     throws WTPropertyVetoException

Sets the value of the attribute: END_TIME_STAMP. End timestamp of the transaction.

Supported API: true

Parameters:

a_EndTimeStamp -

Throws:

WTPropertyVetoException

getStatus

public ESITransactionStatusType getStatus()

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

Supported API: true

Returns:

ESITransactionStatusType

setStatus

public void setStatus(ESITransactionStatusType 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(ESITransactionStatusType a_Status)
                     throws WTPropertyVetoException

Parameters:

a_Status -

Throws:

WTPropertyVetoException

getMessage

public ESITransactionMessage getMessage()

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

Supported API: true

Returns:

ESITransactionMessage

setMessage

public void setMessage(ESITransactionMessage a_Message)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: true

Parameters:

a_Message -

Throws:

WTPropertyVetoException

WTException

getMessageReference

public ObjectReference getMessageReference()

Gets the value of the attribute: MESSAGE_REFERENCE.

Supported API: true

Returns:

ObjectReference

setMessageReference

public void setMessageReference(ObjectReference a_MessageReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: MESSAGE_REFERENCE.

Supported API: true

Parameters:

a_MessageReference -

Throws:

WTPropertyVetoException

messageReferenceValidate

private void messageReferenceValidate(ObjectReference a_MessageReference)
                               throws WTPropertyVetoException

Parameters:

a_MessageReference -

Throws:

WTPropertyVetoException

newESITransaction

static ESITransaction newESITransaction(ESITransactionMessage msg)
                                 throws WTException

Supported API: false

Parameters:

msg -

Returns:

ESITransaction

Throws:

WTException

initialize

protected void initialize(ESITransactionMessage msg)
                   throws WTException

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

Supported API: false

Parameters:

msg -

Throws:

WTException

newESITransaction

static ESITransaction newESITransaction()
                                 throws WTException

Supported API: false

Returns:

ESITransaction

Throws:

WTException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

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

newESITransaction

static ESITransaction newESITransaction(String userName,
                                        int transactionId)
                                 throws WTException

Throws:

WTException

now

private static Timestamp now()