Class VWInvokeInstruction
- java.lang.Object
-
- filenet.vw.api.VWInstructionDefinition
-
- filenet.vw.api.VWInvokeInstruction
-
- All Implemented Interfaces:
- filenet.vw.api.IVWHasFault, java.io.Serializable, java.lang.Cloneable
public final class VWInvokeInstruction extends VWInstructionDefinition implements java.io.Serializable, filenet.vw.api.IVWHasFault
Use this class to invoke an external Web Service. This class defines a workflow step instruction that allows the Process Engine to communicate with a Web Service as part of a workflow compound step instruction process.Create an instance of this class with
VWCompoundStepDefinition.createInvokeInstruction.Types of Message Management This class provides two groups of methods for communication over a partner link, depending on the type of message management desired. An instance of this class should use message management methods from one group or the other, but not both. The two types of partner link-related message management schemes that this class handles are the following:
- Business Process Execution: Contains data in a complex structure that is best expressed using XML.
- Process Engine parameter: Only Process Engine parameter data is passed over the partner link.
Methods in this class for handling the Business Process Execution type of message management include:
- getInputCorrelationSetName
- setInputCorrelationSetName
- getInputCorrelationSetProperties
- setInputCorrelationSetProperties
- getInputMsgExpr
- setInputMsgExpr
- getInputMsgName
- setInputMsgName
- getOutputCorrelationSetName
- setOutputCorrelationSetName
- getOutputCorrelationSetProperties
- setOutputCorrelationSetProperties
- getOutputMsgExpr
- setOutputMsgExpr
- getOutputMsgName
- setOutputMsgName
- getUseReliableMessaging
- setUseReliableMessaging
Methods in this class for handling the Process Engine parameter type of message management include:
- createInComingParameter
- createOutGoingParameter
- deleteAllInComingParameters
- deleteAllOutGoingParameters
- deleteInComingParameter
- deleteOutGoingParameter
- getIncomingParameterDefinition
- getOutGoingParameterDefinition
- getInComingParameterDefinitions
- getOutGoingParameterDefinitions
Parameters for the Web Service methods are specified like any Process Engine workflow method parameter, and must have a data type that is a Process Engine field type.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method and Description VWFaultDefinitioncreateFault(java.lang.String theName, java.lang.String theFaultMessage, java.lang.String theFaultMapName)Creates a fault in this instance.VWWebServiceParameterDefinitioncreateInComingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray)Creates an incoming parameter with name, direction, value, and type information.VWWebServiceParameterDefinitioncreateOutGoingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray)Creates an outgoing parameter with name, direction, value, and type information.voiddeleteAllInComingParameters()Deletes all incoming parameter definitions for this instance.voiddeleteAllOutGoingParameters()Deletes all outgoing parameter definitions for this instance.voiddeleteAllParameters()Deletes all incoming and outgoing parameter definitions for this instance.voiddeleteInComingParameter(int theSequenceNumber)Deletes a parameter definition from the set of incoming parameter definitions stored in this instance.voiddeleteOutGoingParameter(int theSequenceNumber)Deletes a parameter definition from the set of outgoing parameter definitions stored in this instance.VWFaultDefinitiongetCatchAllFault()Gets the general fault-handling (catch all) fault for this instance.java.lang.StringgetCatchAllMap()Gets the general fault-handling (catch all) fault map for this instance.java.lang.StringgetCatchAllMessage()Gets the general fault-handling (catch all) fault message location from this instance.VWFaultDefinitiongetFault(java.lang.String theName)Retrieves a fault definition, specified by name.VWFaultDefinition[]getFaults()Gets the faults contained in this instance.VWWebServiceParameterDefinitiongetInComingParameterDefinition(int theSequenceNumber)Gets a parameter definition from the set of incoming parameter definitions stored in this instance.VWWebServiceParameterDefinition[]getInComingParameterDefinitions()Gets the incoming parameter definitions stored in this instance.java.lang.StringgetInputCorrelationSetName()Gets the input correlation set name for this instance.java.lang.String[][]getInputCorrelationSetProperties()Gets the input correlation set properties for this instance.java.lang.StringgetInputMsgExpr()Gets the input message expression for this instance.java.lang.StringgetInputMsgName()Gets the input message name for this instance .java.lang.StringgetOperationName()Gets the operation name for this instance.VWWebServiceParameterDefinitiongetOutGoingParameterDefinition(int theSequenceNumber)Gets a parameter definition from the set of outgoing parameter definitions stored in this instance.VWWebServiceParameterDefinition[]getOutGoingParameterDefinitions()Gets the outgoing parameter definitions stored in this instance.java.lang.StringgetOutputCorrelationSetName()Gets the output correlation set name for this instance.java.lang.String[][]getOutputCorrelationSetProperties()Gets the output correlation set properties for this instance.java.lang.StringgetOutputMsgExpr()Gets the output message expression for this instance.java.lang.StringgetOutputMsgName()Gets the output message name for this instance.java.lang.StringgetPartnerLinkName()Gets the partner link name for this instance.java.lang.StringgetTimeoutExpr()Gets the timeout expression for this instance.java.lang.StringgetTimeoutMapName()Gets the timeout map name for this instance.booleangetUseReliableMessaging()Indicates whether reliable messaging is used this invoke instruction.voidsetCatchAllMap(java.lang.String theMapName)Sets the general fault-handling (catch all) map name.voidsetCatchAllOutput(java.lang.String theOutput)Sets the general fault-handling (catch all) output expression that will hold the fault information.voidsetFaults(VWFaultDefinition[] theFaults)Sets the faults contained in this instance.voidsetInputCorrelationSetName(java.lang.String theName)Sets the input correlation set name for this instance.voidsetInputCorrelationSetProperties(java.lang.String[][] theProps)Sets the input correlation set properties for this instance.voidsetInputMsgExpr(java.lang.String theInputMsgExpr)Sets the input message expression for this instance.voidsetInputMsgName(java.lang.String theInputMsgName)Sets the input message name for this instance.voidsetOperationName(java.lang.String theOperationName)Sets the operation name for this instance.voidsetOutputCorrelationSetName(java.lang.String theName)Sets the output correlation set name for this instance.voidsetOutputCorrelationSetProperties(java.lang.String[][] theProps)Sets the output correlation set properties for this instance.voidsetOutputMsgExpr(java.lang.String theOutputMsgExpr)Sets the output message expression for this instance.voidsetOutputMsgName(java.lang.String theOutputMsgName)Sets the output message name for this instance.voidsetPartnerLinkName(java.lang.String thePartnerLinkName)Sets the partner link name for this instance.voidsetTimeoutExpr(java.lang.String theTimeoutExpr)Sets the timeout expression for this instance.voidsetTimeoutMapName(java.lang.String theTimeoutMapName)Sets the timeout map name for this instance.voidsetUseReliableMessaging(boolean theUseReliableMessagingFlag)Specifies that reliable messaging (the WS-ReliableMessaging protocol) is to be used for this invoke instruction.java.lang.StringtoString()Returns a String representation of this instance.voidtoXML(java.lang.StringBuffer theBuffer)voidtoXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)voidvalidate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep)-
Methods inherited from class filenet.vw.api.VWInstructionDefinition
getAction, getInstructionId, getStep
-
-
-
-
Method Detail
-
createFault
public VWFaultDefinition createFault(java.lang.String theName, java.lang.String theFaultMessage, java.lang.String theFaultMapName) throws VWException
Creates a fault in this instance.- Parameters:
theName- A String containing the fault name property.theFaultMessage- A String containing the fault message field where the fault message can be stored.theFaultMapName- A String containing the name of the fault map. This can be null.- Returns:
- A VWFaultDefinition object containing the specified fault information.
- Throws:
VWException
-
setCatchAllOutput
public void setCatchAllOutput(java.lang.String theOutput) throws VWExceptionSets the general fault-handling (catch all) output expression that will hold the fault information.- Parameters:
theOutput- A left-side String expression: a String expression that is valid on the left side of an assignment statement, such as the name of a String field in this workflow. This can be null.- Throws:
VWException- See Also:
VWFaultDefinition,VWInvokeInstruction.setCatchAllMap(java.lang.String)
-
setCatchAllMap
public void setCatchAllMap(java.lang.String theMapName) throws VWExceptionSets the general fault-handling (catch all) map name.- Parameters:
theMapName- A String containing the name of the workflow map to be called if a specific fault for the current condition does not exist for this invoke instruction. This can be null.- Throws:
VWException- See Also:
VWFaultDefinition,VWInvokeInstruction.createFault(java.lang.String, java.lang.String, java.lang.String)
-
getCatchAllFault
public VWFaultDefinition getCatchAllFault() throws VWException
Gets the general fault-handling (catch all) fault for this instance.- Returns:
- A VWFaultDefinition object containing the general fault-handling (catch all) fault definition for this invoke instruction. This may be null.
- Throws:
VWException- See Also:
VWFaultDefinition
-
getCatchAllMap
public java.lang.String getCatchAllMap() throws VWExceptionGets the general fault-handling (catch all) fault map for this instance.- Returns:
- A String containing the name of the general fault-handling (catch all) fault map for this invoke instruction. This will be null if the fault map was not specified in setCatchAllMap.
- Throws:
VWException- See Also:
VWFaultDefinition
-
getCatchAllMessage
public java.lang.String getCatchAllMessage() throws VWExceptionGets the general fault-handling (catch all) fault message location from this instance. This is a left-side expression that evaluates to the location, (usually a field name) where the message can be stored.- Returns:
- A VWFaultDefinition object containing the general fault-handling (catch all) fault message for this invoke instruction. This may be null.
- Throws:
VWException- See Also:
VWFaultDefinition
-
getFaults
public VWFaultDefinition[] getFaults() throws VWException
Gets the faults contained in this instance.- Returns:
- An array of all VWFaultDefinition objects contained in this VWInvokeInstruction object, with one element per fault in the invoke instruction. If there are no faults defined in the VWInvokeInstruction, this method returns null.
- Throws:
VWException- See Also:
VWInvokeInstruction.createFault(java.lang.String, java.lang.String, java.lang.String),VWInvokeInstruction.getFault(java.lang.String)
-
setFaults
public void setFaults(VWFaultDefinition[] theFaults) throws VWException
Sets the faults contained in this instance.- Parameters:
theFaults- An array of VWFaultDefinition objects. The array cannot contain any null elements, but this parameter can be null.- Throws:
VWException- Thrown for various causes, including when the input array contains a null element.- See Also:
VWInvokeInstruction.createFault(java.lang.String, java.lang.String, java.lang.String),VWInvokeInstruction.getCatchAllFault(),VWFaultDefinition
-
getFault
public VWFaultDefinition getFault(java.lang.String theName) throws VWException
Retrieves a fault definition, specified by name.- Specified by:
getFaultin interfacefilenet.vw.api.IVWHasFault- Parameters:
theName- A String containing the name of the fault definition.- Returns:
- The WFaultDefinition object specified in the theName parameter.
- Throws:
VWException- Thrown for various causes, including when the fault name does not correctly specify any faults for this VWInvokeInstruction instance.- See Also:
VWInvokeInstruction.createFault(java.lang.String, java.lang.String, java.lang.String),VWFaultDefinition
-
setTimeoutExpr
public void setTimeoutExpr(java.lang.String theTimeoutExpr) throws VWExceptionSets the timeout expression for this instance.- Parameters:
theTimeoutExpr- A String containing the timeout expression value. This must be a valid time expression.- Throws:
VWException
-
getTimeoutExpr
public java.lang.String getTimeoutExpr()
Gets the timeout expression for this instance.- Returns:
- A String containing the timeout expression value for this invoke instruction.
- See Also:
VWInvokeInstruction.setTimeoutExpr(String)
-
setTimeoutMapName
public void setTimeoutMapName(java.lang.String theTimeoutMapName) throws VWExceptionSets the timeout map name for this instance.- Parameters:
theTimeoutMapName- A String containing the new timeout map name for this invoke instruction. The timeout map name should be a name of a map in the containing workflow definition. This can be null.- Throws:
VWException
-
getTimeoutMapName
public java.lang.String getTimeoutMapName()
Gets the timeout map name for this instance.- Returns:
- Timeout map name for this invoke instruction. This will be null if a timeout map name was not specified for setTimeoutMapName.
-
setInputMsgExpr
public void setInputMsgExpr(java.lang.String theInputMsgExpr) throws VWExceptionSets the input message expression for this instance.- Parameters:
theInputMsgExpr- A String containing the XML input message expression value for this invoke instruction (must meet the Web Service WSDL requirements). This can be used in place of parameters for supplying data.- Throws:
VWException- See Also:
VWInvokeInstruction.setInputCorrelationSetName(String),VWInvokeInstruction.setInputCorrelationSetProperties(String[][]),VWInvokeInstruction.getInputMsgExpr(), Types Of Message Management,VWInvokeInstruction.setInputCorrelationSetName(String)
-
getInputMsgExpr
public java.lang.String getInputMsgExpr()
Gets the input message expression for this instance.- Returns:
- A String containing the input message expression for this invoke instruction.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setInputCorrelationSetName(String),VWInvokeInstruction.setInputCorrelationSetProperties(String[][]),VWInvokeInstruction.setInputMsgExpr(String)
-
setOutputMsgExpr
public void setOutputMsgExpr(java.lang.String theOutputMsgExpr) throws VWExceptionSets the output message expression for this instance. The output message expression must be a left-side string expression, such as the name of a String field in this workflow that will receive output from the invoked Web Service.- Parameters:
theOutputMsgExpr- A left-side String expression (a String expression that is valid on the left side of an assignment statement), such as the name of a String field in this workflow.- Throws:
VWException- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(String),VWInvokeInstruction.setOutputCorrelationSetProperties(String[][]),VWInvokeInstruction.getOutputMsgExpr()
-
getOutputMsgExpr
public java.lang.String getOutputMsgExpr()
Gets the output message expression for this instance.- Returns:
- Output A String containing the message expression for this invoke instruction.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(String),VWInvokeInstruction.setOutputCorrelationSetProperties(String[][]),VWInvokeInstruction.setOutputMsgExpr(String)
-
setPartnerLinkName
public void setPartnerLinkName(java.lang.String thePartnerLinkName) throws VWExceptionSets the partner link name for this instance. The partner link name must be the name of a partner link in the same workflow definition that contains this invoke instruction.- Parameters:
thePartnerLinkName- A String containing the partner link name for this invoke instruction.- Throws:
VWException- See Also:
VWPartnerLinkDefinition,VWWorkflowDefinition
-
getPartnerLinkName
public java.lang.String getPartnerLinkName()
Gets the partner link name for this instance.- Returns:
- A String containing the partner link name.
- See Also:
VWPartnerLinkDefinition,VWWorkflowDefinition,VWInvokeInstruction.setPartnerLinkName(java.lang.String)
-
setOperationName
public void setOperationName(java.lang.String theOperationName) throws VWExceptionSets the operation name for this instance. This must be the name of an operation on the port type defined in the associated partner link.- Parameters:
theOperationName- A String containing the operation name.- Throws:
VWException- See Also:
VWPartnerLinkDefinition
-
getOperationName
public java.lang.String getOperationName()
Gets the operation name for this instance. This must be the name of an operation on the port type defined in the associated partner link.- Returns:
- A String containing the operation name.
- See Also:
VWInvokeInstruction.setOperationName(java.lang.String),VWPartnerLinkDefinition
-
createInComingParameter
public VWWebServiceParameterDefinition createInComingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
Creates an incoming parameter with name, direction, value, and type information. This method is designed for situations involving simple data transfer with a Web Service. Parameters may be used in place of the (usually) more complex Business Processing Execution type of message management.- Parameters:
theName- A String containing the name of the parameter.theValue- A String containing the parameter definition value.theType- An integer specifying the field type that applies to the value expression.theIsArray- A boolean value of true indicates the value expression is an array; false otherwise.- Returns:
- Parameter definition.
- Throws:
VWException- Various causes, including the following:- Invalid symbol in the theName parameter
- Parameter with a name that already exists
- Invalid field type
- See Also:
VWWebServiceParameterDefinition,VWModeType
-
createOutGoingParameter
public VWWebServiceParameterDefinition createOutGoingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
Creates an outgoing parameter with name, direction, value, and type information. Designed for situations involving simple data transfer with a Web Service. Parameters may be used in place of the (usually) more complex Business Processing Execution type of message management.- Parameters:
theName- A String containing the name of the parameter.theValue- A String containing the parameter definition value.theType- An integer specifying the field type that applies to the value expression.theIsArray- A boolean value of true indicates the value expression is an array; false otherwise.- Returns:
- A VWWebServiceParameterDefinition object containing the parameter specification.
- Throws:
VWException- Various causes, including the following:- Invalid symbol in the theName parameter
- Parameter with a name that already exists
- Invalid field type
- Invalid mode type
- See Also:
VWWebServiceParameterDefinition,VWModeType
-
deleteOutGoingParameter
public void deleteOutGoingParameter(int theSequenceNumber) throws VWExceptionDeletes a parameter definition from the set of outgoing parameter definitions stored in this instance.- Parameters:
theSequenceNumber- An integer identifying the parameter definition to be deleted as an index into the array of outgoing parameter definitions.- Throws:
VWException- Thrown for various causes, including when the input parameter name is invalid.- See Also:
VWWebServiceParameterDefinition
-
deleteInComingParameter
public void deleteInComingParameter(int theSequenceNumber) throws VWExceptionDeletes a parameter definition from the set of incoming parameter definitions stored in this instance.- Parameters:
theSequenceNumber- An integer identifying the parameter definition to be deleted as an index into the array of incoming parameter definitions.- Throws:
VWException- Thrown for various causes, including when the input parameter name is invalid.- See Also:
VWWebServiceParameterDefinition
-
deleteAllParameters
public void deleteAllParameters() throws VWExceptionDeletes all incoming and outgoing parameter definitions for this instance.- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
deleteAllInComingParameters
public void deleteAllInComingParameters() throws VWExceptionDeletes all incoming parameter definitions for this instance.- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
deleteAllOutGoingParameters
public void deleteAllOutGoingParameters() throws VWExceptionDeletes all outgoing parameter definitions for this instance.- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
getOutGoingParameterDefinition
public VWWebServiceParameterDefinition getOutGoingParameterDefinition(int theSequenceNumber) throws VWException
Gets a parameter definition from the set of outgoing parameter definitions stored in this instance.- Parameters:
theSequenceNumber- An integer identifying the parameter definition to be deleted as an index into the array of outgoing parameter definitions.- Returns:
- A VWWebServiceParameterDefinition object for the parameter definition indicated in theSequenceNumber.
- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
getInComingParameterDefinition
public VWWebServiceParameterDefinition getInComingParameterDefinition(int theSequenceNumber) throws VWException
Gets a parameter definition from the set of incoming parameter definitions stored in this instance.- Parameters:
theSequenceNumber- An integer identifying the parameter definition to be deleted as an index into the array of incoming parameter definitions.- Returns:
- A VWWebServiceParameterDefinition object for the parameter definition indicated in theSequenceNumber.
- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
getOutGoingParameterDefinitions
public VWWebServiceParameterDefinition[] getOutGoingParameterDefinitions() throws VWException
Gets the outgoing parameter definitions stored in this instance.- Returns:
- An array of VWWebServiceParameterDefinition objects containing the parameter definitions for this instance.
- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
getInComingParameterDefinitions
public VWWebServiceParameterDefinition[] getInComingParameterDefinitions() throws VWException
Gets the incoming parameter definitions stored in this instance.- Returns:
- An array of VWWebServiceParameterDefinition objects containing the parameter definitions for this instance.
- Throws:
VWException- See Also:
VWWebServiceParameterDefinition
-
toString
public java.lang.String toString()
Returns a String representation of this instance.- Specified by:
toStringin classVWInstructionDefinition- Returns:
- A String representing this instance.
- See Also:
VWActionType
-
validate
public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value,EDefVectorwill be updated to contain any validation errors found.- Specified by:
validatein classVWInstructionDefinition- Parameters:
theSession- The current VWSession object if logged on. This is needed for various parts of the validation process. This can be null; however, areas of validation requiring a logon will not be validated.EDefVector- A Vector to which will be added a VWValidationError object for each validation error found. This can be null; in this case, a new Vector is used.Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
myStep- The VWCompoundStepDefinition object containing this event.- Throws:
VWException- Thrown if an error occurs during the validation.
-
toXML
public void toXML(java.lang.StringBuffer theBuffer) throws VWExceptionDeprecated. UseVWWorkflowDefinition.write(java.io.OutputStream)orVWWorkflowDefinition.writeToFile(String).Appends an XML string representing this instance to the StringBuffer specified.Warning: This XML string is nonextensible, and cannot be modified.
- Specified by:
toXMLin classVWInstructionDefinition- Parameters:
theBuffer- A StringBuffer that will be appended with XML content representing this instance.- Throws:
VWException- Thrown when the parameter is null.- See Also:
VWWorkflowDefinition
-
toXPDL
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWExceptionDeprecated. UseVWWorkflowCollectionDefinition.write(java.io.OutputStream)orVWWorkflowCollectionDefinition.writeToFile(String).Appends an XPDL string representing this instance to the StringBuffer specified.Warning: This XPDL string is nonextensible, and cannot be modified in any way.
- Parameters:
indentA- A String specifying the initial indentation for this XPDL section.theBuffer- A StringBuffer that is to be appended with the XPDL content.- Throws:
VWException- Thrown when a parameter is null.- See Also:
VWWorkflowCollectionDefinition
-
setInputCorrelationSetName
public void setInputCorrelationSetName(java.lang.String theName) throws VWExceptionSets the input correlation set name for this instance. A correlation set stores the message state value so that a work item can be matched with a particular message.- Parameters:
theName- A String containing the correlation set name. This can be null. A null value signifies there is no correlation set name, normally because another type of message management is used, or because a state value is not needed. Correlation set names can contain only alphanumeric and underscore ("_") characters.- Throws:
VWException- Thrown when the specified name exceeds the maximum number of characters, or when an invalid character is included in the name.- See Also:
VWInvokeInstruction.getInputCorrelationSetName(),VWInvokeInstruction.setInputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setInputMsgExpr(java.lang.String)
-
getInputCorrelationSetName
public java.lang.String getInputCorrelationSetName()
Gets the input correlation set name for this instance.- Returns:
- A String containing the correlation set name.
- See Also:
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String),VWInvokeInstruction.setInputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setInputMsgExpr(java.lang.String), Types Of Message Management,VWInvokeInstruction.setInputCorrelationSetName(java.lang.String)
-
setOutputCorrelationSetName
public void setOutputCorrelationSetName(java.lang.String theName) throws VWExceptionSets the output correlation set name for this instance. A correlation set stores the message state value, so that a work item can be matched with a particular message.- Parameters:
theName- A String containing the correlation set name. This can be null. A null value signifies there is no correlation set name, normally because another type of message management is used, or because a state value is not needed. Correlation set names can contain only alphanumeric and underscore ("_") characters.- Throws:
VWException- Thrown when the specified name exceeds the maximum number of characters, or when an invalid character is included in the name.- See Also:
VWInvokeInstruction.getOutputCorrelationSetName(),VWInvokeInstruction.setOutputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setOutputMsgExpr(java.lang.String)
-
getOutputCorrelationSetName
public java.lang.String getOutputCorrelationSetName()
Gets the output correlation set name for this instance.- Returns:
- A String containing the output correlation set name.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(java.lang.String),VWInvokeInstruction.setOutputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setOutputMsgExpr(java.lang.String)
-
setInputCorrelationSetProperties
public void setInputCorrelationSetProperties(java.lang.String[][] theProps) throws VWExceptionSets the input correlation set properties for this instance. A correlation set stores the message state value, so that the work item can be matched with a particular message.- Parameters:
theProps- A two-dimensional String array of correlation set properties. Each correlation set property is comprised of a property name and its corresponding Process Engine expression query.- Throws:
VWException- Thrown when the array dimension is incorrect (there are not an number of elements in the arrays), or when one of the arrays contains a null element.- See Also:
- Types Of Message Management,
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String),VWInvokeInstruction.getInputCorrelationSetProperties(),VWInvokeInstruction.setInputMsgExpr(java.lang.String)
-
getInputCorrelationSetProperties
public java.lang.String[][] getInputCorrelationSetProperties()
Gets the input correlation set properties for this instance.- Returns:
- A two-dimensional String array of correlation set properties. Each correlation set property is comprised of a property name and its corresponding Process Engine expression query.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String)
-
setOutputCorrelationSetProperties
public void setOutputCorrelationSetProperties(java.lang.String[][] theProps) throws VWExceptionSets the output correlation set properties for this instance. A correlation set stores the message state value, so that the work item can be matched with a particular message.- Parameters:
theProps- A two-dimensional String array of correlation set properties. Each correlation set property is comprised of a property name and its corresponding Process Engine expression query.- Throws:
VWException- Thrown when the array dimension is incorrect (there are not an number of elements in the arrays), or when one of the arrays contains a null element.- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(java.lang.String),VWInvokeInstruction.getOutputCorrelationSetProperties(),VWInvokeInstruction.setOutputMsgExpr(java.lang.String)
-
getOutputCorrelationSetProperties
public java.lang.String[][] getOutputCorrelationSetProperties()
Gets the output correlation set properties for this instance.- Returns:
- A two-dimensional String array of correlation set properties. Each correlation set property is comprised of a property name and its corresponding Process Engine expression query.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(java.lang.String),VWInvokeInstruction.setOutputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setOutputMsgExpr(java.lang.String)
-
setInputMsgName
public void setInputMsgName(java.lang.String theInputMsgName) throws VWExceptionSets the input message name for this instance.- Parameters:
theInputMsgName- A String containing the input message name. This can be null.- Throws:
VWException- See Also:
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String),VWInvokeInstruction.setInputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.getInputMsgName(), Types Of Message Management,VWInvokeInstruction.setInputCorrelationSetName(java.lang.String)
-
getInputMsgName
public java.lang.String getInputMsgName()
Gets the input message name for this instance .- Returns:
- A String containing the input message name.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setInputCorrelationSetName(java.lang.String),VWInvokeInstruction.setInputCorrelationSetProperties(java.lang.String[][]),VWInvokeInstruction.setInputMsgName(java.lang.String)
-
setOutputMsgName
public void setOutputMsgName(java.lang.String theOutputMsgName) throws VWExceptionSets the output message name for this instance.- Parameters:
theOutputMsgName- A String containing the output message name. This can be null.- Throws:
VWException- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(String),VWInvokeInstruction.setOutputCorrelationSetProperties(String[][]),VWInvokeInstruction.getOutputMsgName()
-
getOutputMsgName
public java.lang.String getOutputMsgName()
Gets the output message name for this instance.- Returns:
- Output A String containing the message name.
- See Also:
- Types Of Message Management,
VWInvokeInstruction.setOutputCorrelationSetName(String),VWInvokeInstruction.setOutputCorrelationSetProperties(String[][]),VWInvokeInstruction.setOutputMsgName(String)
-
setUseReliableMessaging
public void setUseReliableMessaging(boolean theUseReliableMessagingFlag) throws VWExceptionSpecifies that reliable messaging (the WS-ReliableMessaging protocol) is to be used for this invoke instruction. If the Web service does not support the WS-ReliableMessaging protocol, non-reliable messaging is used.- Parameters:
theUseReliableMessagingFlag- A boolean value of true enables reliable messaging for this invoke instruction; false otherwise.- Throws:
VWException
-
getUseReliableMessaging
public boolean getUseReliableMessaging() throws VWExceptionIndicates whether reliable messaging is used this invoke instruction. If the Web service does not support the WS-ReliableMessaging protocol, non-reliable messaging is used.- Returns:
- A boolean value of true if reliable messaging is enabled for this invoke instruction.
- Throws:
VWException
-
-