|
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.VWReceiveInstruction
public class VWReceiveInstruction
This class represents a Process Engine workflow step instruction that allows a Process Engine to communicate through a local web service listener and receive either an XML message or a set of Process Engine workflow operation parameters.
Create an instance of this class with VWCompoundStepDefinition.createReceiveInstruction(String,String)
.
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 that this class handles are
the following:
Parameters for Java API Web Service methods are like any
Process Engine workflow operation parameter, and must have a
data type that is a Process Engine field type.
Methods in this class for handling the Business Process Execution
type of message management include:
Note: When using the Business Process Execution
type of message management, the Process Engine matches
the work item for the workflow step to a given instance of
VWReceiveInstruction by using the correlation set properties.
Methods in this class for handling the Process Engine parameter type of message management include:
Note: When using the Process Engine parameter
type of message management, the Process Engine matches
the work item for the workflow step to a given instance of
VWReceiveInstruction by using the correlation value expression.
VWPartnerLinkDefinition
,
VWWebServiceParameterDefinition
,
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. |
VWWebServiceParameterDefinition |
createParameter(java.lang.String theName,
java.lang.String theValue,
int theType,
boolean theIsArray)
Creates a parameter with name, direction, value, and type information. |
void |
deleteAllParameters()
Deletes all parameter definitions for this receive instruction. |
void |
deleteParameter(int theSequenceNumber)
Deletes a parameter definition from the set of parameter definitions stored in this receive instruction. |
boolean |
getAuthentication()
Gets the value of theAuthenticationFlag, indicating whether a Web Service security header for caller authentication is generated for this operation. |
int |
getCorrelationParameterSequenceNumber()
Gets the correlation parameter sequence number of this receive instruction; may be -1 if there is no correlation parameter. |
java.lang.String |
getCorrelationSetName()
Gets the correlation set name. |
java.lang.String[][] |
getCorrelationSetProperties()
Gets the correlation set properties. |
java.lang.String |
getCorrelationValueExpression()
Gets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null. |
java.lang.String |
getMessageExpr()
Gets the message expression of this receive instruction. |
java.lang.String |
getMessageFromElementName()
Gets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
java.lang.String |
getMessageFromSchemaName()
Gets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
int |
getOnlineId()
Gets the online ID, if available, or -1. |
java.lang.String |
getOperationName()
Gets the operation name of this receive instruction. |
VWWebServiceParameterDefinition |
getParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of parameter definitions stored in this receive instruction. |
VWWebServiceParameterDefinition[] |
getParameterDefinitions()
Gets the parameter definitions stored in this receive instruction. |
java.lang.String |
getPartnerLinkName()
Gets the partner link name of this receive instruction. |
java.lang.String[] |
getSecurityGroup()
Gets the security group assigned for this receive instruction. |
java.lang.String |
getTimeoutExpr()
Gets the timeout expression of this receive instruction, in the same format in which the expression was set. |
java.lang.String |
getTimeoutMapName()
Gets the timeout map name of this receive instruction. |
void |
setAuthentication(boolean theAuthenticationFlag)
Sets the value of theAuthenticationFlag, indicating a Web Service security header authenticating the caller is to be used for this operation. |
void |
setCorrelationParameterSequenceNumber(int theParamSeqNumber)
Sets the correlation parameter sequence number of this receive instruction; may be -1, indicating there is no correlation parameter. |
void |
setCorrelationSetName(java.lang.String theName)
Sets the correlation set name; may be null. |
void |
setCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties. |
void |
setCorrelationValueExpression(java.lang.String theValueExpr)
Sets an expression that evaluates to the correlation set parameter value for this receive instruction; may be null. |
void |
setMessageExpr(java.lang.String theMsgExpr)
Sets the message expression of this receive instruction. |
void |
setMessageFromElementName(java.lang.String theElement)
Sets the name of the schema element that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
void |
setMessageFromSchemaName(java.lang.String theSchema)
Sets the name of the schema that defines the WSDL message associated with this receive message, where the schema is defined in the containing workflow definition. |
void |
setOperationName(java.lang.String theOperationName)
Sets the operation name of this receive instruction, which must be the name of an operation on the port type defined in the associated partner link. |
void |
setPartnerLinkName(java.lang.String thePartnerLinkName)
Sets the partner link name of this receive instruction. |
void |
setSecurityGroup(java.lang.String[] theSecurityGroup)
Sets the security group to use for this receive instruction. |
void |
setTimeoutExpr(java.lang.String theTimeoutExpr)
Sets the timeout expression of this receive instruction; must be a valid time expression. |
void |
setTimeoutMapName(java.lang.String theTimeoutMapName)
Sets the timeout map name of this receive instruction. |
java.lang.String |
toString()
Gets the name of this VWReceiveInstruction instruction |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer 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 |
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 void setTimeoutExpr(java.lang.String theTimeoutExpr) throws VWException
theTimeoutExpr
- Time expression value for this receive instruction.
VWException
public java.lang.String getTimeoutExpr()
setTimeoutExpr(String)
public void setTimeoutMapName(java.lang.String theTimeoutMapName) throws VWException
theTimeoutMapName
- null
or the timeout map name
for this receive instruction.
VWException
public java.lang.String getTimeoutMapName()
public void setMessageExpr(java.lang.String theMsgExpr) throws VWException
theMsgExpr
- Left side String expression:
a String expression which is valid on
the left side of an assignment statement,
such as the name of a String field in this workflow.
VWException
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
getMessageExpr()
,
Types Of Message Managementpublic java.lang.String getMessageExpr()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic void setPartnerLinkName(java.lang.String thePartnerLinkName) throws VWException
thePartnerLinkName
- Partner link name
VWException
- Thrown for various causes, including when
the input partner link name is not the name of a partner link
contained in workflow associated with this receive instruction.
VWException
- Thrown for various causes, including when
the input partner link name does not exist on the system.VWPartnerLinkDefinition
,
VWWorkflowDefinition
public java.lang.String getPartnerLinkName()
setPartnerLinkName(String)
,
VWPartnerLinkDefinition
,
VWWorkflowDefinition
public void setOperationName(java.lang.String theOperationName) throws VWException
theOperationName
- Operation name
VWException
VWPartnerLinkDefinition
public java.lang.String getOperationName()
setOperationName(String)
,
VWPartnerLinkDefinition
public VWWebServiceParameterDefinition createParameter(java.lang.String theName, java.lang.String theValue, int theType, boolean theIsArray) throws VWException
theName
- Name of the parameter.
theValue
- Parameter definition value.
theType
- Integer specifying the
field type
that applies to the value expression.
theIsArray
- boolean expression: true
specifies the
value expression is an array; false
, otherwise.
VWException
- Various causes, including the following:
VWModeType
,
Types Of Message Managementpublic void deleteParameter(int theSequenceNumber) throws VWException
theSequenceNumber
- Sequence number of the parameter definition to be deleted.
VWException
- Thrown for various causes, including when
the input parameter name is invalid.VWWebServiceParameterDefinition
public void deleteAllParameters() throws VWException
VWException
VWWebServiceParameterDefinition
,
VWWebServiceParameterDefinition
public VWWebServiceParameterDefinition getParameterDefinition(int theSequenceNumber) throws VWException
theSequenceNumber
- A property of the web service parameter
which uniquely identifies the web service parameter with an integer.
VWException
- Thrown for various causes, including when
the parameter cannot be found.public VWWebServiceParameterDefinition[] getParameterDefinitions() throws VWException
VWException
getParameterDefinition(int)
,
Types Of Message Managementpublic 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 in any way.
toXML
in class VWInstructionDefinition
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer 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 will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void setMessageFromSchemaName(java.lang.String theSchema) throws VWException
theSchema
- Schema name
VWException
getMessageFromSchemaName()
,
setCorrelationSetName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic java.lang.String getMessageFromSchemaName()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic void setMessageFromElementName(java.lang.String theElement) throws VWException
theElement
- Schema element name.
VWException
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
getMessageFromElementName()
,
setMessageExpr(String)
,
Types Of Message Management,
VWWorkflowDefinition
public java.lang.String getMessageFromElementName()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Management,
VWWorkflowDefinition
public void setAuthentication(boolean theAuthenticationFlag) throws VWException
theAuthenticationFlag
- A boolean value of true
generates a Web Service
security header for caller authentication; false
indicates no authentication.
VWException
setSecurityGroup(String[])
,
getSecurityGroup()
,
getAuthentication()
public boolean getAuthentication()
true
indicates a Web Service
security header for caller authentication is generated;
false
indicates no authentication.setSecurityGroup(String[])
,
getSecurityGroup()
,
setAuthentication(boolean)
public int getOnlineId()
public void setCorrelationSetName(java.lang.String theName) throws VWException
theName
- Correlation set name, or 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 name can only contain
letters, numbers, and underscores, and the name length must not
exceed 24 characters.
VWException
- Thrown for various causes, including an
illegal character in the input name, or the input name contains
more than 24 characters.getCorrelationSetName()
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
setCorrelationSetProperties(String[][])
public java.lang.String getCorrelationSetName()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Management,
setCorrelationSetName(String)
public void setCorrelationSetProperties(java.lang.String[][] theProps) throws VWException
Note: When using the Business Process Execution type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation set properties.
theProps
- Correlation set properties,
a two dimensional array (n by 2,
where n is the number of properties)
which is an array of pairs, each comprised of a property name and its
corresponding Process Engine expression query.
Correlation set properties provide a server with a state value for the current instance of the workflow object, so that a specific instance may be identified.
VWException
- Thrown for various causes including an incorrectly
dimensioned input String array, or a null
entry in the input array.getCorrelationSetProperties()
,
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
public java.lang.String[][] getCorrelationSetProperties()
Note: When using the Business Process Execution type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation set properties.
setCorrelationSetProperties(String[][])
,
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
public void setCorrelationParameterSequenceNumber(int theParamSeqNumber) throws VWException
theParamSeqNumber
- Correlation parameter sequence number for
this receive instruction, or -1.
A value of -1 signifies that there is no correlation parameter,
which is only valid if the receive is a launch receive (a
receive immediately following the launch step).
A value other than -1 represents the sequence number of
one of the parameters defined in this receive instruction.
VWException
getCorrelationParameterSequenceNumber()
,
createParameter(String,String,int,boolean)
,
setCorrelationValueExpression(String)
,
Types of Message Managementpublic int getCorrelationParameterSequenceNumber()
createParameter(String,String,int,boolean)
,
setCorrelationParameterSequenceNumber(int)
,
setCorrelationValueExpression(String)
public void setCorrelationValueExpression(java.lang.String theValueExpr) throws VWException
Note: When using the Process Engine parameter type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation value expression.
theValueExpr
- Right side String expression that evaluates
to the correlation set parameter value for this receive
instruction, or null
if there is no expression used to calculate
the correlation set parameter value.
VWException
createParameter(String,String,int,boolean)
,
setCorrelationParameterSequenceNumber(int)
,
getCorrelationValueExpression()
public java.lang.String getCorrelationValueExpression()
Note: When using the Process Engine parameter type of message management, the Process Engine matches the work item for the workflow step to a given instance of VWReceiveInstruction by using the correlation value expression.
null
if there is no expression used to calculate
the correlation set parameter value.createParameter(String,String,int,boolean)
,
setCorrelationParameterSequenceNumber(int)
,
setCorrelationValueExpression(String)
public void setSecurityGroup(java.lang.String[] theSecurityGroup) throws VWException
getAuthentication()
== true),
this method specifies the LDAP users and groups allowed to invoke the
receive instruction.
theSecurityGroup
- A string array of LDAP user and group names.
The array can be null, but if not null, it cannot contain any null or empty elements.
VWException
- if an error occurs.getSecurityGroup()
,
setAuthentication(boolean)
,
getAuthentication()
public java.lang.String[] getSecurityGroup()
setSecurityGroup(String[])
,
setAuthentication(boolean)
,
getAuthentication()
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |