|
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.VWReplyInstruction
public class VWReplyInstruction
This class defines a workflow step instruction that allows a Process Engine to communicate through a local Web Service and send a reply XML message to a location defined by the associated partner link, or it may send parameters to this location.
A VWReplyInstruction instance allows a business workflow process step to send a message in reply to a message that was received through a VWReceiveInstruction instance activity using the same portType, over the same partner link, before any other reply has been sent for that particular receive activity.
Create an instance of this class with VWCompoundStepDefinition.createReplyInstruction(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:
Methods in this class for handling the Process Engine parameter type of message management include:
VWReceiveInstruction
,
VWPartnerLinkDefinition
,
VWInvokeInstruction
,
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 reply instruction. |
void |
deleteParameter(int theSequenceNumber)
Deletes a parameter definition from the set of parameter definitions stored in this reply instruction. |
java.lang.String |
getCorrelationSetName()
Gets the correlation set name. |
java.lang.String[][] |
getCorrelationSetProperties()
Gets the correlation set properties for this reply message. |
java.lang.String |
getFaultName()
Gets the fault name for this VWReplyInstruction instance. |
boolean |
getHasAttachments()
Gets the HasAttachments flag, indicating the message is associated with one or more attachments. |
java.lang.String |
getMessageExpr()
Gets the message expression of this reply instruction. |
java.lang.String |
getMessageFromElementName()
Gets the name of the schema element that defines the WSDL message associated with this reply 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 reply message, where the schema is defined in the containing workflow definition. |
java.lang.String |
getOperationName()
Gets the operation name of this reply instruction. |
VWWebServiceParameterDefinition |
getParameterDefinition(int theSequenceNumber)
Gets a parameter definition from the set of parameter definitions stored in this reply instruction. |
VWWebServiceParameterDefinition[] |
getParameterDefinitions()
Gets a parameter definition from the set of parameter definitions stored in this reply instruction. |
java.lang.String |
getPartnerLinkName()
Gets the partner link name of this reply instruction. |
void |
setCorrelationSetName(java.lang.String theName)
Sets the correlation set name. |
void |
setCorrelationSetProperties(java.lang.String[][] theProps)
Sets the output correlation set properties for this reply message. |
void |
setFaultName(java.lang.String theName)
Creates a fault in this VWReplyInstruction instance. |
void |
setHasAttachments(boolean theHasAttachmentsFlag)
Sets the HasAttachments flag, indicating whether the message is associated with one or more attachments. |
void |
setMessageExpr(java.lang.String theMessageExpr)
Sets the message expression of this reply instruction. |
void |
setMessageFromElementName(java.lang.String theElement)
Sets the name of the schema element that defines the WSDL message associated with this reply message, where the schema is defined in the containing workflow definition. |
void |
setMessageFromSchemaName(java.lang.String theSchemaName)
Sets the name of the schema that defines the WSDL message associated with this reply message, where the schema is defined in the containing workflow definition. |
void |
setOperationName(java.lang.String theOperationName)
Sets the operation name of this reply 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 reply instruction. |
java.lang.String |
toString()
Gets the name of this VWReplyInstruction 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 setFaultName(java.lang.String theName) throws VWException
theName
- Fault name, or null
if no fault is defined.
VWException
public java.lang.String getFaultName() throws VWException
VWException
public java.lang.String getMessageExpr()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic void setMessageExpr(java.lang.String theMessageExpr) throws VWException
theMessageExpr
- Valid String expression for
the message expression.
VWException
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
getMessageExpr()
,
Types Of Message Managementpublic void setPartnerLinkName(java.lang.String thePartnerLinkName) throws VWException
thePartnerLinkName
- Partner link name
for this reply instruction.
VWException
- Thrown for various causes, including when
the input partner link name is not the name of a partner linkVWPartnerLinkDefinition
,
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
- The name of the parameter definition.
theValue
- String representation of the
parameter definition.
theType
- Integer specifying the
field type
that applies to the value expression.
theIsArray
- boolean expression: true
specifies the
value expression is an array; otherwise, specify false
.
VWException
- Various causes, including the
following:
VWWebServiceParameterDefinition
,
VWModeType
public 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
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
public java.lang.String toString()
toString
in class VWInstructionDefinition
VWActionType
public void setHasAttachments(boolean theHasAttachmentsFlag) throws VWException
theHasAttachmentsFlag
- true
indicates
the message is associated with one or more attachments;
false
indicates otherwise.
VWException
public boolean getHasAttachments()
true
indicates the message is associated
with one or more attachments.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 theSchemaName) throws VWException
theSchemaName
- Schema name
VWException
setCorrelationSetName(String)
,
getMessageFromSchemaName()
,
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
VWWorkflowDefinition
,
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageExpr(String)
,
getMessageFromElementName()
,
Types Of Message Managementpublic java.lang.String getMessageFromElementName()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
VWWorkflowDefinition
,
Types Of Message Managementpublic void setCorrelationSetName(java.lang.String theName) throws VWException
theName
- Correlation set name; may 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 only contain letters
numbers and underscores.
VWException
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
getCorrelationSetName()
public java.lang.String getCorrelationSetName()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic void setCorrelationSetProperties(java.lang.String[][] theProps) throws VWException
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.
VWException
- Thrown for various causes including an incorrectly
dimensioned input String array, or a null
entry in the input arraygetCorrelationSetProperties()
,
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
Types Of Message Managementpublic java.lang.String[][] getCorrelationSetProperties()
setCorrelationSetName(String)
,
setMessageFromSchemaName(String)
,
setMessageFromElementName(String)
,
setMessageExpr(String)
,
getCorrelationSetProperties()
,
Types Of Message Management
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |