|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWInstructionDefinition
filenet.vw.api.VWInvokeInstruction
public final class VWInvokeInstruction
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
.
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:
Methods in this class for handling the Business Process Execution type of message management include:
Methods in this class for handling the Process Engine parameter type of message management include:
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.
VWInstructionDefinition
,
VWReceiveInstruction
,
VWReplyInstruction
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
VWFaultDefinition |
createFault(java.lang.String theName,
java.lang.String theFaultMessage,
java.lang.String theFaultMapName)
Creates a fault in this instance. |
VWWebServiceParameterDefinition |
createInComingParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates an incoming parameter with name, direction, value, and type information. |
VWWebServiceParameterDefinition |
createOutGoingParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates an outgoing parameter with name, direction, value, and type information. |
void |
deleteAllInComingParameters()
Deletes all incoming parameter definitions for this instance. |
void |
deleteAllOutGoingParameters()
Deletes all outgoing parameter definitions for this instance. |
void |
deleteAllParameters()
Deletes all incoming and outgoing parameter definitions for this instance. |
void |
deleteInComingParameter(int theSequenceNumber)
Deletes a parameter definition from the set of incoming parameter definitions stored in this instance. |
void |
deleteOutGoingParameter(int theSequenceNumber)
Deletes a parameter definition from the set of outgoing parameter definitions stored in this instance. |
VWFaultDefinition |
getCatchAllFault()
Gets the general fault-handling (catch all) fault for this instance. |
java.lang.String |
getCatchAllMap()
Gets the general fault-handling (catch all) fault map for this instance. |
java.lang.String |
getCatchAllMessage()
Gets the general fault-handling (catch all) fault message location from this instance. |
VWFaultDefinition |
getFault(java.lang.String theName)
Retrieves a fault definition, specified by name. |
VWFaultDefinition[] |
getFaults()
Gets the faults contained in this instance. |
VWWebServiceParameterDefinition |
getInComingParameterDefinition(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.String |
getInputCorrelationSetName()
Gets the input correlation set name for this instance. |
java.lang.String[][] |
getInputCorrelationSetProperties()
Gets the input correlation set properties for this instance. |
java.lang.String |
getInputMsgExpr()
Gets the input message expression for this instance. |
java.lang.String |
getInputMsgName()
Gets the input message name for this instance . |
java.lang.String |
getOperationName()
Gets the operation name for this instance. |
VWWebServiceParameterDefinition |
getOutGoingParameterDefinition(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.String |
getOutputCorrelationSetName()
Gets the output correlation set name for this instance. |
java.lang.String[][] |
getOutputCorrelationSetProperties()
Gets the output correlation set properties for this instance. |
java.lang.String |
getOutputMsgExpr()
Gets the output message expression for this instance. |
java.lang.String |
getOutputMsgName()
Gets the output message name for this instance. |
java.lang.String |
getPartnerLinkName()
Gets the partner link name for this instance. |
java.lang.String |
getTimeoutExpr()
Gets the timeout expression for this instance. |
java.lang.String |
getTimeoutMapName()
Gets the timeout map name for this instance. |
boolean |
getUseReliableMessaging()
Indicates whether reliable messaging is used this invoke instruction. |
void |
setCatchAllMap(java.lang.String theMapName)
Sets the general fault-handling (catch all) map name. |
void |
setCatchAllOutput(java.lang.String theOutput)
Sets the general fault-handling (catch all) output expression that will hold the fault information. |
void |
setFaults(VWFaultDefinition[] theFaults)
Sets the faults contained in this instance. |
void |
setInputCorrelationSetName(java.lang.String theName)
Sets the input correlation set name for this instance. |
void |
setInputCorrelationSetProperties(java.lang.String[][] theProps)
Sets the input correlation set properties for this instance. |
void |
setInputMsgExpr(java.lang.String theInputMsgExpr)
Sets the input message expression for this instance. |
void |
setInputMsgName(java.lang.String theInputMsgName)
Sets the input message name for this instance. |
void |
setOperationName(java.lang.String theOperationName)
Sets the operation name for this instance. |
void |
setOutputCorrelationSetName(java.lang.String theName)
Sets the output correlation set name for this instance. |
void |
setOutputCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties for this instance. |
void |
setOutputMsgExpr(java.lang.String theOutputMsgExpr)
Sets the output message expression for this instance. |
void |
setOutputMsgName(java.lang.String theOutputMsgName)
Sets the output message name for this instance. |
void |
setPartnerLinkName(java.lang.String thePartnerLinkName)
Sets the partner link name for this instance. |
void |
setTimeoutExpr(java.lang.String theTimeoutExpr)
Sets the timeout expression for this instance. |
void |
setTimeoutMapName(java.lang.String theTimeoutMapName)
Sets the timeout map name for this instance. |
void |
setUseReliableMessaging(boolean theUseReliableMessagingFlag)
Specifies that reliable messaging (the WS-ReliableMessaging protocol) is to be used for this invoke instruction. |
java.lang.String |
toString()
Returns a String representation of this instance. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the StringBuffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the StringBuffer specified. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep)
Validates this instance, appending any validation errors found to the specified Vector object. |
Methods inherited from class filenet.vw.api.VWInstructionDefinition |
---|
getAction, getInstructionId, getStep |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface filenet.vw.api.IVWHasFault |
---|
getStep |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWFaultDefinition createFault(java.lang.String theName, java.lang.String theFaultMessage, java.lang.String theFaultMapName) throws VWException
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.
VWException
public void setCatchAllOutput(java.lang.String theOutput) throws VWException
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.
VWException
VWFaultDefinition
,
setCatchAllMap(java.lang.String)
public void setCatchAllMap(java.lang.String theMapName) throws VWException
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.
VWException
VWFaultDefinition
,
createFault(java.lang.String, java.lang.String, java.lang.String)
public VWFaultDefinition getCatchAllFault() throws VWException
VWException
VWFaultDefinition
public java.lang.String getCatchAllMap() throws VWException
VWException
VWFaultDefinition
public java.lang.String getCatchAllMessage() throws VWException
VWException
VWFaultDefinition
public VWFaultDefinition[] getFaults() throws VWException
VWException
createFault(java.lang.String, java.lang.String, java.lang.String)
,
getFault(java.lang.String)
public void setFaults(VWFaultDefinition[] theFaults) throws VWException
theFaults
- An array of VWFaultDefinition objects.
The array cannot contain any null elements, but this parameter can be null.
VWException
- Thrown for various causes, including when
the input array contains a null element.createFault(java.lang.String, java.lang.String, java.lang.String)
,
getCatchAllFault()
,
VWFaultDefinition
public VWFaultDefinition getFault(java.lang.String theName) throws VWException
getFault
in interface filenet.vw.api.IVWHasFault
theName
- A String containing the name of the fault definition.
VWException
- Thrown for various causes, including when
the fault name does not correctly specify any faults for this
VWInvokeInstruction instance.createFault(java.lang.String, java.lang.String, java.lang.String)
,
VWFaultDefinition
public void setTimeoutExpr(java.lang.String theTimeoutExpr) throws VWException
theTimeoutExpr
- A String containing the timeout expression value. This must be a valid time expression (see
time expression
for an example).
VWException
public java.lang.String getTimeoutExpr()
setTimeoutExpr(String)
public void setTimeoutMapName(java.lang.String theTimeoutMapName) throws VWException
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.
VWException
public java.lang.String getTimeoutMapName()
public void setInputMsgExpr(java.lang.String theInputMsgExpr) throws VWException
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.
VWException
setInputCorrelationSetName(String)
,
setInputCorrelationSetProperties(String[][])
,
getInputMsgExpr()
,
Types Of Message Management,
setInputCorrelationSetName(String)
public java.lang.String getInputMsgExpr()
setInputCorrelationSetName(String)
,
setInputCorrelationSetProperties(String[][])
,
setInputMsgExpr(String)
public void setOutputMsgExpr(java.lang.String theOutputMsgExpr) throws VWException
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.
VWException
setOutputCorrelationSetName(String)
,
setOutputCorrelationSetProperties(String[][])
,
getOutputMsgExpr()
public java.lang.String getOutputMsgExpr()
setOutputCorrelationSetName(String)
,
setOutputCorrelationSetProperties(String[][])
,
setOutputMsgExpr(String)
public void setPartnerLinkName(java.lang.String thePartnerLinkName) throws VWException
thePartnerlinkName
- A String containing the partner link name for this invoke instruction.
VWException
VWPartnerLinkDefinition
,
VWWorkflowDefinition
public java.lang.String getPartnerLinkName()
VWPartnerLinkDefinition
,
VWWorkflowDefinition
,
setPartnerLinkName(java.lang.String)
public void setOperationName(java.lang.String theOperationName) throws VWException
theOperationName
- A String containing the operation name.
VWException
VWPartnerLinkDefinition
public java.lang.String getOperationName()
setOperationName(java.lang.String)
,
VWPartnerLinkDefinition
public VWWebServiceParameterDefinition createInComingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
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.
VWException
- Various causes, including the following:
VWWebServiceParameterDefinition
,
VWModeType
public VWWebServiceParameterDefinition createOutGoingParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
theName
- A String containing the name of the parameter.theMode
- An integer specifying the mode 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.
VWException
- Various causes, including the following:
VWWebServiceParameterDefinition
,
VWModeType
public void deleteOutGoingParameter(int theSequenceNumber) throws VWException
theSequenceNumber
- An integer identifying the parameter definition to be deleted as an index into the array
of outgoing parameter definitions.
VWException
- Thrown for various causes, including when
the input parameter name is invalid.VWWebServiceParameterDefinition
public void deleteInComingParameter(int theSequenceNumber) throws VWException
theSequenceNumber
- An integer identifying the parameter definition to be deleted as an index into the array
of incoming parameter definitions.
VWException
- Thrown for various causes, including when
the input parameter name is invalid.VWWebServiceParameterDefinition
public void deleteAllParameters() throws VWException
VWException
VWWebServiceParameterDefinition
public void deleteAllInComingParameters() throws VWException
VWException
VWWebServiceParameterDefinition
public void deleteAllOutGoingParameters() throws VWException
VWException
VWWebServiceParameterDefinition
public VWWebServiceParameterDefinition getOutGoingParameterDefinition(int theSequenceNumber) throws VWException
theSequenceNumber
- An integer identifying the parameter definition to be deleted as an index into the array
of outgoing parameter definitions.
VWException
VWWebServiceParameterDefinition
public VWWebServiceParameterDefinition getInComingParameterDefinition(int theSequenceNumber) throws VWException
theSequenceNumber
- An integer identifying the parameter definition to be deleted as an index into the array
of incoming parameter definitions.
VWException
VWWebServiceParameterDefinition
public VWWebServiceParameterDefinition[] getOutGoingParameterDefinitions() throws VWException
VWException
VWWebServiceParameterDefinition
public VWWebServiceParameterDefinition[] getInComingParameterDefinitions() throws VWException
VWException
VWWebServiceParameterDefinition
public java.lang.String toString()
toString
in class VWInstructionDefinition
VWActionType
public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep) throws VWException
validate
in class VWInstructionDefinition
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.
VWException
- Thrown if an error occurs during the validation.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified.
toXML
in class VWInstructionDefinition
theBuffer
- A StringBuffer that will be appended with
XML content representing this instance.
VWException
- Thrown when the parameter is null.VWXMLUtil
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that is to be appended with the XPDL content.
VWException
- Thrown when a parameter is null.VWXMLUtil
public void setInputCorrelationSetName(java.lang.String theName) throws VWException
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. The length of the name must not exceed 24 characters.
Correlation set names can contain only alphanumeric and underscore ("_") characters.
VWException
- Thrown when the specified name exceeds 24 characters, or when an invalid character is
included in the name.getInputCorrelationSetName()
,
setInputCorrelationSetProperties(java.lang.String[][])
,
setInputMsgExpr(java.lang.String)
public java.lang.String getInputCorrelationSetName()
setInputCorrelationSetName(java.lang.String)
,
setInputCorrelationSetProperties(java.lang.String[][])
,
setInputMsgExpr(java.lang.String)
,
Types Of Message Management,
setInputCorrelationSetName(java.lang.String)
public void setOutputCorrelationSetName(java.lang.String theName) throws VWException
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. The length of the name must not exceed 24 characters.
Correlation set names can contain only alphanumeric and underscore ("_") characters.
VWException
- Thrown when the specified name exceeds 24 characters, or when an invalid character is
included in the name.getOutputCorrelationSetName()
,
setOutputCorrelationSetProperties(java.lang.String[][])
,
setOutputMsgExpr(java.lang.String)
public java.lang.String getOutputCorrelationSetName()
setOutputCorrelationSetName(java.lang.String)
,
setOutputCorrelationSetProperties(java.lang.String[][])
,
setOutputMsgExpr(java.lang.String)
public void setInputCorrelationSetProperties(java.lang.String[][] theProps) throws VWException
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.
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.setInputCorrelationSetName(java.lang.String)
,
getInputCorrelationSetProperties()
,
setInputMsgExpr(java.lang.String)
public java.lang.String[][] getInputCorrelationSetProperties()
setInputCorrelationSetName(java.lang.String)
public void setOutputCorrelationSetProperties(java.lang.String[][] theProps) throws VWException
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.
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.setOutputCorrelationSetName(java.lang.String)
,
getOutputCorrelationSetProperties()
,
setOutputMsgExpr(java.lang.String)
public java.lang.String[][] getOutputCorrelationSetProperties()
setOutputCorrelationSetName(java.lang.String)
,
setOutputCorrelationSetProperties(java.lang.String[][])
,
setOutputMsgExpr(java.lang.String)
public void setInputMsgName(java.lang.String theInputMsgName) throws VWException
theInputMsgName
- A String containing the input message name. This can be null.
VWException
setInputCorrelationSetName(java.lang.String)
,
setInputCorrelationSetProperties(java.lang.String[][])
,
getInputMsgName()
,
Types Of Message Management,
setInputCorrelationSetName(java.lang.String)
public java.lang.String getInputMsgName()
setInputCorrelationSetName(java.lang.String)
,
setInputCorrelationSetProperties(java.lang.String[][])
,
setInputMsgName(java.lang.String)
public void setOutputMsgName(java.lang.String theOutputMsgName) throws VWException
theOutputMsgName
- A String containing the output message name. This can be null.
VWException
setOutputCorrelationSetName(String)
,
setOutputCorrelationSetProperties(String[][])
,
getOutputMsgName()
public java.lang.String getOutputMsgName()
setOutputCorrelationSetName(String)
,
setOutputCorrelationSetProperties(String[][])
,
setOutputMsgName(String)
public void setUseReliableMessaging(boolean theUseReliableMessagingFlag) throws VWException
theUseReliableMessagingFlag
- A boolean value of true enables reliable messaging for this invoke
instruction; false otherwise.
VWException
public boolean getUseReliableMessaging() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |