com.ptc.windchill.esi.wf
Class ESIResultEvent

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

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

Field Summary

private static String	CLASSNAME
private String	errorMessage
static String	ESI_RELEASE_COMPLETE
private static String	RESOURCE
private boolean	successful
private String	targetUfid
private String	txUfid

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

ESIResultEvent(Persistable eventTarget)
Constuctor for this class.

ESIResultEvent(String eventType, Object target)
This constructor has been added for internal use by event dispatcher.

ESIResultEvent(WTCollection eventTargets)
Constuctor for this class.

Method Summary

private void	errorMessageValidate(String a_ErrorMessage)
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.
WTCollection	getTargets() Return a WTCollection of event targets.
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.
private void	targetUfidValidate(String a_TargetUfid)
private void	txUfidValidate(String a_TxUfid)

Methods inherited from class wt.events.KeyedEvent

generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, getEventType, toMultiObjectEvent, toSingleObjectEvents, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

successful

private boolean successful

errorMessage

private String errorMessage

targetUfid

private String targetUfid

txUfid

private String txUfid

ESI_RELEASE_COMPLETE

public static final String ESI_RELEASE_COMPLETE

See Also:

Constant Field Values

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 -

ESIResultEvent

public ESIResultEvent(WTCollection eventTargets)

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

Supported API: false

Parameters:

eventTargets -

ESIResultEvent

public ESIResultEvent(String eventType,
                      Object target)

This constructor has been added for internal use by event dispatcher. Defaults to the ESI_RELEASE_COMPLETE event type.

Supported API: false

Parameters:

eventType -

target -

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

errorMessageValidate

private void errorMessageValidate(String a_ErrorMessage)
                           throws WTPropertyVetoException

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

targetUfidValidate

private void targetUfidValidate(String a_TargetUfid)
                         throws WTPropertyVetoException

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

txUfidValidate

private void txUfidValidate(String a_TxUfid)
                     throws WTPropertyVetoException

Parameters:

a_TxUfid -

Throws:

WTPropertyVetoException

getTarget

public Persistable getTarget()

Returns the event target associated with this event.

Supported API: true

Returns:

Persistable

getTargets

public WTCollection getTargets()

Return a WTCollection of event targets.

Supported API: false

Returns:

WTCollection