Package 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 Details

    • 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 Details

    • 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

    • getEsiReleaseUfid

      public String getEsiReleaseUfid()
      Gets the value of the attribute: esiReleaseUfid; The UFID of the ESIRelease object that represents the given ESI release.

      Supported API: true
      Returns:
      String

    • setEsiReleaseUfid

      public void setEsiReleaseUfid(String a_EsiReleaseUfid) throws WTPropertyVetoException
      Sets the value of the attribute: esiReleaseUfid; The UFID of the ESIRelease object that represents the given ESI release.

      Supported API: true
      Parameters:
      a_EsiReleaseUfid -
      Throws:
      WTPropertyVetoException

    • getTarget

      public Persistable getTarget()
      Returns the event target associated with this event.

      Supported API: true
      Returns:
      Persistable

    • consume

      public void consume()
      Consumes this event, if this event can be consumed by Listener. Synch Robot for Release To Manufacturing must call this method to mark this event consumed.

      Supported API: true

    • isConsumed

      public boolean isConsumed()
      Returns the status of the event consumption. If the event object is consumed by the listener then method will return true otherwise false.

      Supported API: true
      Returns:
      true when listener consumes the object otherwise false.