com.ptc.windchill.esi.wf
Class ESIResultEvent

java.lang.Object
  wt.events.KeyedEvent
      com.ptc.windchill.esi.wf.ESIResultEvent

All Implemented Interfaces:

wt.events.summary.SummarizedEvent

public class ESIResultEvent
extends KeyedEvent

ESI workflows may suspend until external processes are complete. When they do, the ESIResultEvent is the trigger that tells the workflow to resume. Objects of this class convey to a workflow whether or not an ESI external request succeeded.

Supported API: true

Extendable: true

Constructor Summary

ESIResultEvent(Persistable eventTarget)
Constuctor for this class.

Method Summary

String	getErrorMessage() Gets the value of the attribute: errorMessage; An optional message to provide to the workflow.
Persistable	getTarget() Returns the event target associated with this event.
String	getTargetUfid() Gets the value of the attribute: targetUfid; The UFID to the ESITarget associated with this result.
String	getTxUfid() Gets the value of the attribute: txUfid; The UFID to the ESITtransaction associated with this result.
boolean	isSuccessful() Gets the value of the attribute: successful; Defines whether or not the external process succeeded.
void	setErrorMessage(String a_ErrorMessage) Sets the value of the attribute: errorMessage; An optional message to provide to the workflow.
void	setSuccessful(boolean a_Successful) Sets the value of the attribute: successful; Defines whether or not the external process succeeded.
void	setTargetUfid(String a_TargetUfid) Sets the value of the attribute: targetUfid; The UFID to the ESITarget associated with this result.
void	setTxUfid(String a_TxUfid) Sets the value of the attribute: txUfid; The UFID to the ESITtransaction associated with this result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ESIResultEvent

public ESIResultEvent(Persistable eventTarget)

Constuctor for this class. Insures that the object is always in the correct state.

Supported API: true

Parameters:

eventTarget -

Method Detail

isSuccessful

public boolean isSuccessful()

Gets the value of the attribute: successful; Defines whether or not the external process succeeded.

Supported API: true

Returns:

boolean

setSuccessful

public void setSuccessful(boolean a_Successful)
                   throws WTPropertyVetoException

Sets the value of the attribute: successful; Defines whether or not the external process succeeded.

Supported API: true

Parameters:

a_Successful -

Throws:

WTPropertyVetoException

getErrorMessage

public String getErrorMessage()

Gets the value of the attribute: errorMessage; An optional message to provide to the workflow.

Supported API: true

Returns:

String

setErrorMessage

public void setErrorMessage(String a_ErrorMessage)
                     throws WTPropertyVetoException

Sets the value of the attribute: errorMessage; An optional message to provide to the workflow.

Supported API: true

Parameters:

a_ErrorMessage -

Throws:

WTPropertyVetoException

getTargetUfid

public String getTargetUfid()

Gets the value of the attribute: targetUfid; The UFID to the ESITarget associated with this result.

Supported API: true

Returns:

String

setTargetUfid

public void setTargetUfid(String a_TargetUfid)
                   throws WTPropertyVetoException

Sets the value of the attribute: targetUfid; The UFID to the ESITarget associated with this result.

Supported API: true

Parameters:

a_TargetUfid -

Throws:

WTPropertyVetoException

getTxUfid

public String getTxUfid()

Gets the value of the attribute: txUfid; The UFID to the ESITtransaction associated with this result.

Supported API: true

Returns:

String

setTxUfid

public void setTxUfid(String a_TxUfid)
               throws WTPropertyVetoException

Sets the value of the attribute: txUfid; The UFID to the ESITtransaction associated with this result.

Supported API: true

Parameters:

a_TxUfid -

Throws:

WTPropertyVetoException

getTarget

public Persistable getTarget()

Returns the event target associated with this event.

Supported API: true

Returns:

Persistable