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:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification, WTContained, wt.recent.RecentlyVisited

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

static String	CREATOR Label for the attribute; The name of the user who created this entry.
static String	DELETED Label for the attribute.
static String	END_TIME_STAMP Label for the attribute; End timestamp of the transaction.
static String	ID_NUMBER Label for the attribute.
static String	MESSAGE Label for the attribute.
static String	MESSAGE_REFERENCE Label for the attribute.
static String	START_TIME_STAMP Label for the attribute; Start timestamp of the transaction.
static String	STATUS Label for the attribute.

Method Summary

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.
boolean	isDeleted() Gets the value of the attribute: DELETED.
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.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Detail

ID_NUMBER

public static final String ID_NUMBER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DELETED

public static final String DELETED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

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

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

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

STATUS

public static final String STATUS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

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

Method Detail

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

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

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