|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides run-time support to plugin-supplied nodes and actions.
Field Summary | |
static java.lang.String |
AUDIT_HOME
JNDI/EJB environment entry for the Audit bean. |
static java.lang.String |
BUSINESS_CALENDAR_HOME
JNDI/EJB environment entry for the BusinessCalendar
bean. |
static int |
CALTYPE_ASSIGNEE
Use task assignee calendar when evaluating expressions. |
static int |
CALTYPE_GREGORIAN
Use Gregorian calendar when evaluating expressions. |
static int |
CALTYPE_ORG
Use instance org calendar when evaluating expressions. |
static int |
CALTYPE_SPECIFIC
Use specific calendar when evaluating expressions. |
static int |
CONTINUE
Return code to permit processing of subsequent operations. |
static int |
EXIT_CONTINUE
Return code to exit an error handler and permit processing of subsequent operations. |
static int |
EXIT_RETRY
Return code to exit an error handler and request retry of the failed operation. |
static int |
EXIT_ROLLBACK
Return code to exit an error handler and request rollback of user transaction. |
static int |
STOP
Return code to prevent processing of subsequent operations. |
static java.lang.String |
TEMPLATE_DEFINITION_HOME
JNDI/EJB environment entry for the TemplateDefinitionRO bean. |
static java.lang.String |
WLPI_PRINCIPAL_HOME
JNDI/EJB environment entry for the WLPIPrincipal bean. |
static java.lang.String |
WORKFLOW_INSTANCE_HOME
JNDI/EJB environment entry for the WorkflowInstance bean. |
static java.lang.String |
XML_REPOSITORY_HOME
JNDI/EJB environment entry for the XMLRepository bean. |
Method Summary | |
void |
addClientResponse(java.lang.String xml)
Append an XML subdocument to the API method's return value. |
java.lang.String |
getErrorHandler()
Return the name of the current error handler. |
com.bea.wlpi.server.eventprocessor.EventData |
getEventData()
Return the data associated with the current event, if any. |
int |
getExceptionNumber()
Return the message number of the error being handled by the exception handler. |
java.lang.Exception |
getExceptionObject()
Return the exception object being handled by the exception handler. |
int |
getExceptionSeverity()
Return the severity code of the error being handled by the exception handler. |
java.lang.String |
getExceptionText()
Return the message text of the error being handled by the exception handler. |
java.lang.String |
getExceptionType()
Return the type of exception being handled by the exception handler. |
java.lang.String |
getInstanceID()
Return the ID of the current workflow instance. |
java.lang.String |
getOrg()
Return the ID of the organization in which the current instance is running. |
java.lang.Object |
getPluginInstanceData(java.lang.String pluginName)
Get the workflow instance data provided by the named plugin. |
java.lang.String |
getRequestor()
Return the ID of the user who made the current API request. |
boolean |
getRollbackOnly()
Return whether the current user transaction has been marked for rollback only. |
java.lang.String |
getTemplateDefinitionID()
Return the ID of the current template definition. |
PluginObject |
getTemplateDefinitionPluginData(java.lang.String pluginName)
Return the plugin template definition data for the specified plugin. |
java.lang.String |
getTemplateID()
Return the ID of the current template. |
PluginObject |
getTemplatePluginData(java.lang.String pluginName)
Return the plugin template data for the specified plugin. |
VariableInfo |
getVariableInfo(java.lang.String name)
Return information about a variable in the template definition. |
java.lang.Object |
getVariableValue(java.lang.String name)
Return the value of a workflow instance variable. |
com.bea.wlpi.server.instance.WorkflowInstanceData |
getWorkflowInstanceData()
Return the workflow instance state. |
java.lang.String |
instantiate(java.lang.String orgID,
java.lang.String initialNode,
java.lang.String parentTemplateDefinitionID,
java.lang.String parentID,
java.lang.String parentNodeID,
com.bea.wlpi.server.eventprocessor.EventData eventData,
java.util.List lVariableValues,
java.util.Map pluginData)
Create a new workflow instance. |
int |
invokeErrorHandler(java.lang.String handlerName,
java.lang.Exception e)
Invoke an error handler by name. |
boolean |
isAuditEnabled()
Return whether auditing is enabled for the current workflow. |
void |
setErrorHandler(java.lang.String handlerName)
Set the current error handler. |
void |
setPluginInstanceData(java.lang.String pluginName,
java.lang.Object data)
Set the workflow instance data provided by the named plugin. |
void |
setRollbackOnly()
Set the current user transaction for rollback only. |
void |
setVariableValue(java.lang.String name,
java.lang.Object value)
Set the value of a workflow instance variable. |
java.lang.String |
taskAssign(java.lang.String instanceID,
java.lang.String taskID,
java.lang.String assigneeID,
boolean bRole,
boolean bLoadBalance)
Assign a workflow task to a participant. |
java.lang.String |
taskDoit(java.lang.String instanceID,
java.lang.String taskID)
Execute a workflow task. |
java.lang.String |
taskMarkDone(java.lang.String instanceID,
java.lang.String taskID)
Mark a workflow task as complete. |
java.lang.String |
taskSetProperties(java.lang.String instanceID,
java.lang.String taskID,
int priority,
boolean doneWithoutExecute,
boolean executeIfDone,
boolean unmarkDone,
boolean modifiable,
boolean reassignment)
Set the properties for a workflow task. |
java.lang.String |
taskUnassign(java.lang.String instanceID,
java.lang.String taskID)
Unassign a workflow task. |
java.lang.String |
taskUnmarkDone(java.lang.String instanceID,
java.lang.String taskID)
Mark a workflow task as incomplete. |
Field Detail |
public static final java.lang.String AUDIT_HOME
Audit
bean.public static final java.lang.String WLPI_PRINCIPAL_HOME
WLPIPrincipal
bean.public static final java.lang.String TEMPLATE_DEFINITION_HOME
TemplateDefinitionRO
bean.public static final java.lang.String WORKFLOW_INSTANCE_HOME
WorkflowInstance
bean.public static final java.lang.String BUSINESS_CALENDAR_HOME
BusinessCalendar
bean.public static final java.lang.String XML_REPOSITORY_HOME
XMLRepository
bean.public static final int CALTYPE_ORG
public static final int CALTYPE_ASSIGNEE
public static final int CALTYPE_SPECIFIC
public static final int CALTYPE_GREGORIAN
public static final int CONTINUE
public static final int STOP
public static final int EXIT_ROLLBACK
public static final int EXIT_CONTINUE
public static final int EXIT_RETRY
Method Detail |
public boolean getRollbackOnly()
true
if the transaction is set for rollback only.public void setRollbackOnly()
public PluginObject getTemplatePluginData(java.lang.String pluginName)
pluginName
- The reverse-DNS plugin name.public PluginObject getTemplateDefinitionPluginData(java.lang.String pluginName)
pluginName
- The reverse-DNS plugin name.public java.lang.String getTemplateID()
public java.lang.String getTemplateDefinitionID()
public java.lang.String getInstanceID()
public com.bea.wlpi.server.instance.WorkflowInstanceData getWorkflowInstanceData() throws WorkflowException
Admin.getInstanceVariables(java.lang.String)
and
Admin.setInstanceVariable(java.lang.String, java.lang.String, java.lang.String, java.lang.Object)
instead.
public com.bea.wlpi.server.eventprocessor.EventData getEventData()
public java.lang.String getOrg() throws WorkflowException
public java.lang.String getRequestor()
public boolean isAuditEnabled()
public void addClientResponse(java.lang.String xml)
xml
- XML subdocument to append.public java.lang.String instantiate(java.lang.String orgID, java.lang.String initialNode, java.lang.String parentTemplateDefinitionID, java.lang.String parentID, java.lang.String parentNodeID, com.bea.wlpi.server.eventprocessor.EventData eventData, java.util.List lVariableValues, java.util.Map pluginData) throws WorkflowException
orgID
- The ID of the organization within which the instance is to
run.initialNode
- The ID of the start node to activate.parentTemplateDefinitionID
- The ID of the parent template
definition (if instantiating a sub-workflow).parentID
- The ID of the parent workflow instance (if instantiating
a sub-workflow).parentNodeID
- The ID of the node in the parent workflow to be
notified of events in subflows life-cycle (if instantiating a
sub-workflow).eventData
- An event datum to pass to the called start nodes in
the workflow. This is an alternative to setting variable values
explicitly via the lVariableValues
parameter.lVariableValues
- A list of
VariableInfo
objects to initialize the
workflow instance variables. Note that non-null
initial
values for all mandatory input variables must be
passed through the lVariableValues
parameter.Worklist.instantiateWorkflow(
String, String, String, Map, Map)
public java.lang.String taskDoit(java.lang.String instanceID, java.lang.String taskID) throws WorkflowException
Worklist.taskExecute(java.lang.String, java.lang.String, java.lang.String)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to execute.Worklist.taskExecute(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String taskMarkDone(java.lang.String instanceID, java.lang.String taskID) throws WorkflowException
Worklist.taskMarkDone(java.lang.String, java.lang.String, java.lang.String)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to mark complete.Worklist.taskMarkDone(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String taskUnmarkDone(java.lang.String instanceID, java.lang.String taskID) throws WorkflowException
Worklist.taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to mark incomplete.Worklist.taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String taskAssign(java.lang.String instanceID, java.lang.String taskID, java.lang.String assigneeID, boolean bRole, boolean bLoadBalance) throws WorkflowException
Worklist.taskAssign(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to assign.assigneeID
- The ID of the participant to whom the task is to be
assigned. Must be a valid WebLogic Process Integrator role or user ID.bRole
- true
if the assigneeID
is a role
ID.bLoadBalance
- true
to apply the load-balancing
across the members of a role. This parameter is ignored if
bRole
is false
.Worklist.taskAssign(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
public java.lang.String taskUnassign(java.lang.String instanceID, java.lang.String taskID) throws WorkflowException
Worklist.taskUnassign(java.lang.String, java.lang.String, java.lang.String)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to unassign.Worklist.taskUnassign(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String taskSetProperties(java.lang.String instanceID, java.lang.String taskID, int priority, boolean doneWithoutExecute, boolean executeIfDone, boolean unmarkDone, boolean modifiable, boolean reassignment) throws WorkflowException
Worklist.taskSetProperties(java.lang.String, java.lang.String, java.lang.String, int, boolean, boolean, boolean, boolean, boolean)
method.
instanceID
- The ID of the workflow instance.taskID
- The ID of the task to update.priority
- The task instance priority (0=low, 1=medium, 2=high).doneWithoutExecute
- true
to permit a user to mark a
task instance as complete (by calling the
Worklist.taskMarkDone(java.lang.String, java.lang.String, java.lang.String)
method).executeIfDone
- true
to permit a user to execute
a task instance after it has been marked as complete (by calling the
Worklist.taskExecute(java.lang.String, java.lang.String, java.lang.String)
method).unmarkDone
- true
to permit a user to mark a task
instance as incomplete (by calling the
Worklist.taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)
method).modifiable
- true
to permit a user to modify a task
instance's runtime properties (by calling the
Worklist.taskSetProperties(java.lang.String, java.lang.String, java.lang.String, int, boolean, boolean, boolean, boolean, boolean)
method).reassignable
- true
to permit a user to reassign a
task instance to another participant (by calling the
Worklist.taskAssign(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
method).Worklist.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.Worklist.taskSetProperties(java.lang.String, java.lang.String, java.lang.String, int, boolean, boolean, boolean, boolean, boolean)
public void setVariableValue(java.lang.String name, java.lang.Object value) throws WorkflowException
value
parameter:Variable Type | Value Class | Notes |
---|---|---|
Boolean | java.lang.Boolean, |
Numbers are treated as true if non-zero.
Strings are treated as true if they have the value
"true". The same treatment is applied to the node
value of Node and the first item of a
NodeList . Any other value class throws an
exception. |
Date | java.util.Date |
Strings are converted to dates using
VariableInfo.DEFAULT_DATE_FORMAT
|
Double | java.lang.Number, |
Numbers simply yield their doubleValue() .
Boolean true yields 1.0 ,
false yields 0.0 . Strings must
contain a valid string representation of a double constant.
The same treatment is applied to the node value of
Node and the first item of a
NodeList . Any other value class throws an
exception. |
Entity EJB | javax.ejb.Handle |
The system checks the value to ensure that it is a handle for an entity EJB, then stores the handle. Any other value class throws an exception. |
Integer | java.lang.Number, |
Numbers simply yield their intValue() .
Boolean true yields 1 ,
false yields 0 . Strings must
contain a valid string representation of an integer constant.
The same treatment is applied to the node value of
Node and the first item of a
NodeList . Any other value class throws an
exception. |
Object |
java.lang.Object |
Any serializable Java object can be stored. |
<Plugin> | java.lang.Object |
The value must be assignable to the value class defined by the plugin for this variable type. Any other value class throws an exception. |
Session EJB | javax.ejb.Handle |
The system checks the value to ensure that it is a handle for a session EJB, then stores the handle. Any other value class throws an exception. |
String | org.w3c.dom.Node, |
All object types yield their string representation.
The same treatment is applied to the node value of
Node and the first item of a
NodeList . |
XML | org.w3c.dom.Node, |
The system performs a non-validating SAX parse on string values
to ensure that they contain valid XML markup, then converts the
string to a UTF-8 encoded byte array. A DOM Node
and the first item of a NodeList object is
serialized to a UTF-8 encoded byte array. A byte[]
value is assumed to be a UTF-8 encoded string containing a valid
XML document. The value is not parsed or verified. Any other
value class throws an exception. |
name
- The name of the variable to set.value
- The new value to assign, which must be compatible with the
variable's declared type, as described in the above table.Admin.setInstanceVariable(java.lang.String, java.lang.String, java.lang.String, java.lang.Object)
public java.lang.Object getVariableValue(java.lang.String name) throws WorkflowException
name
- The name of the variable whose value is required.Admin.getInstanceVariables(java.lang.String)
public VariableInfo getVariableInfo(java.lang.String name)
public java.lang.String getErrorHandler() throws WorkflowException
public void setErrorHandler(java.lang.String handlerName) throws WorkflowException
handlerName
- The name of the error handler to store. If
null
, the method restores the previous exception handler.
If the empty string, the method makes the system error handler current.public int invokeErrorHandler(java.lang.String handlerName, java.lang.Exception e) throws WorkflowException
public java.lang.String getExceptionType()
public int getExceptionSeverity()
WorkflowException.ERROR_SYSTEM
,
WorkflowException.ERROR_WORKFLOW
,
WorkflowException.WARNING_WORKFLOW
,
WorkflowException.ERROR_UNKNOWN
, or
WorkflowException.ERROR_CUSTOM
public int getExceptionNumber()
Messages
public java.lang.String getExceptionText()
Messages
public java.lang.Exception getExceptionObject()
public java.lang.Object getPluginInstanceData(java.lang.String pluginName) throws WorkflowException
pluginName
- The reverse-DNS name of the plugin that supplied the
data.setPluginInstanceData(java.lang.String, java.lang.Object)
public void setPluginInstanceData(java.lang.String pluginName, java.lang.Object data) throws WorkflowException
pluginName
- The reverse-DNS name of the plugin supplying the data.data
- The serializable plugin instance data.
Set plugin-provided instance data.getPluginInstanceData(java.lang.String)
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |