SDX 6.4.x Application Library Guide > Available Workflow Event Descriptors > Class ProcessEventDescriptor

Class ProcessEventDescriptor

public class net.juniper.smgt.workflow.engine.adapters.ProcessEventDescriptor 
extends net.juniper.smgt.workflow.engine.EventDescriptor

This event descriptor holds the information that starts an external process and receives back some results when used with the ProcessAdapter. The communication to and from the process is made through the token.

When a descriptor is created by a work item, it carries the input token to that process, and when it comes back from the event adapter, it carries the output token. The use of the token is optional, but if you do not use it as an input, then you are forbidden to use it as an output.

The input token does not need to be an exact copy of the work item input token, because it may contain only the attributes relevant to the external process. In the same sense, the output token may contain only the attributes created or modified by the process. The success or failure of the process is encoded in the token.

 Constructor Detail

 ProcessEventDescriptor
 public EMailEventDescriptor()


 Method Detail

 getCmdLine
public java.lang.String getCmdLine()

 Gets the command line used to start the external process. If the process fails to execute, the cause is reported here.
 Returns: java.lang.String
 
 getExecuted
public boolean getExecuted()

 Returns true if the process was able to execute and terminate normally. It does not mean that it was successful, which is encoded in the token.
 Returns: boolean
  
 getToken
public net.juniper.smgt.workflow.WFToken getToken()

 Gets the token embedded in the descriptor. It contains the token produced by the executed process.
 Returns: net.juniper.smgt.workflow.WFToken
 
 setCmdLine
public void setCmdLine(java.lang.String newCmdLine)

 Sets the command line used to start the external process.
 Parameters: newCmdLine - java.lang.String
 
 setToken
public void setToken(net.juniper.smgt.workflow.WFToken newToken)

 Sets the token embedded in the descriptor. This token is sent to the external process.
 Parameters: newToken - net.juniper.smgt.workflow.WFToken