|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides WebLogic Process Integrator administrative functions.
AdminHome
Field Summary | |
static int |
TASKCOUNT_COMPLETED
Count of tasks that have completed. |
static int |
TASKCOUNT_INACTIVE
Count of tasks which have not started yet. |
static int |
TASKCOUNT_OVERDUE
Count of tasks that have started and their due date has passed. |
static int |
TASKCOUNT_PENDING
Count of tasks which have started but have not completed. |
static int |
TASKCOUNT_TOTAL
Count of all tasks assigned to user/role. |
Method Summary | |
java.lang.String |
addBusinessCalendar(BusinessCalendarInfo calendarInfo)
Create a new business calendar. |
java.lang.String |
addBusinessOperation(ClassInvocationDescriptor descriptor)
Create a new business operation implemented by a Java class. |
java.lang.String |
addBusinessOperation(EJBInvocationDescriptor descriptor)
Create a new business operation implemented by an EJB. |
void |
addEventKey(EventKeyInfo eventKeyInfo)
Create a new event key. |
java.lang.String |
addReroute(java.lang.String orgID,
java.lang.String from,
java.lang.String to,
int type,
java.sql.Timestamp effective,
java.sql.Timestamp expiry)
Create a new task reroute. |
boolean |
checkForTemplateDefinitionInstances(java.lang.String templateDefinitionID)
Check whether the specified workflow template definition has any instances. |
boolean |
checkForTemplateInstances(java.lang.String templateID)
Check whether a workflow template has any started instances which are not yet complete. |
java.lang.String |
createTemplate(java.lang.String name,
java.util.Collection orgs)
Deprecated. Use the new createTemplate(String,String,Collection)
or createTemplate(String,String,Collection,Object) |
java.lang.String |
createTemplate(java.lang.String name,
java.lang.String xml,
java.util.Collection orgs)
Create a workflow template with the specified name. |
java.lang.String |
createTemplate(java.lang.String name,
java.lang.String xml,
java.util.Collection orgs,
java.lang.Object requestID)
Create a workflow template with the specified name. |
java.lang.String |
createTemplateDefinition(java.lang.String templateID,
java.lang.String name,
java.lang.String xml)
Create a definition for a workflow template, using the name and content supplied. |
java.lang.String |
createTemplateDefinition(java.lang.String templateId,
java.lang.String name,
java.lang.String xml,
java.lang.Object requestID)
Create a definition for a workflow template, using the name and content supplied. |
void |
deleteBusinessCalendar(java.lang.String calendarID)
Delete a business calendar. |
void |
deleteBusinessOperation(java.lang.String busOpID)
Delete a business operation. |
void |
deleteEventKey(EventKeyInfo eventKeyInfo)
Delete an event key. |
void |
deleteInstance(java.lang.String instanceID)
Delete a workflow instance. |
void |
deleteReroute(java.lang.String rerouteID)
Delete a task reroute. |
void |
deleteTemplate(java.lang.String templateID)
Delete a workflow template. |
void |
deleteTemplateDefinition(java.lang.String templateDefinitionID)
Delete a workflow template definition. |
void |
deleteTemplateDefinitionInstances(java.lang.String templateDefinitionID,
java.lang.String orgID,
boolean bStarted,
java.util.Date from,
java.util.Date to)
Delete instances of a workflow template definition in an organization. |
void |
deleteTemplateInstances(java.lang.String templateID,
java.lang.String orgID,
boolean bStarted,
java.util.Date from,
java.util.Date to)
Delete instances of a workflow template in an organization. |
byte[] |
exportPackage(PublishPackage publishPackage,
java.lang.Object credential)
Exports a package of workflow objects specified by publishPackage. |
java.lang.String |
findCallableWorkflow(java.lang.String templateName,
java.lang.String templateID,
java.lang.String orgID)
Return the most appropriate (active and effective) callable workflow template. |
java.sql.Timestamp |
findOldestTemplateInstance(java.lang.String templateID)
Find the date and time of the oldest completed instance for this template. |
java.util.List |
getAllBusinessCalendars(boolean includeDefinition)
List the business calendars defined in the workflow system. |
java.lang.String |
getBusinessCalendarDefinition(java.lang.String calendarID)
Return the definition of a business calendar. |
java.util.List |
getBusinessOperations()
List the currently defined business operations. |
java.util.List |
getCallableWorkflows(java.lang.String orgID)
Return a List of workflows that can be called. |
ClassDescriptor |
getClassDescriptor(java.lang.String className)
Get a server side class descriptor. |
java.util.List |
getEventKeyInfo()
List the event keys defined within the workflow system. |
int |
getInstanceCount(java.lang.String templateID)
Get a count of instances. |
int |
getInstanceCount(java.lang.String templateID,
boolean completed)
Get a count of instances. |
InstanceInfo |
getInstanceInfo(java.lang.String instanceID)
Return information about the specified workflow instance. |
java.util.List |
getInstanceTasks(java.lang.String instanceID)
List the tasks in a workflow instance. |
java.util.List |
getInstanceVariables(java.lang.String instanceID)
List the variables in a workflow instance. |
java.lang.Object |
getPluginInstanceData(java.lang.String pluginName,
java.lang.String instanceID)
Retrieve the plugin-supplied data associated with a workflow instance. |
java.util.List |
getReroutes(java.lang.String orgID)
List the task reroutes defined within an organization. |
int[] |
getTaskCounts(java.lang.String assigneeID,
java.lang.String orgID,
boolean role)
Count the tasks assigned to a participant in an organization. |
java.util.List |
getTasks(java.lang.String assigneeID,
java.lang.String orgID,
boolean role)
List the tasks assigned to a participant in an organization. |
java.util.List |
getTasks(java.lang.String assigneeID,
java.lang.String orgID,
boolean role,
boolean incompleteOnly,
boolean sortAscending)
List the tasks assigned to a participant in an organization. |
TemplateInfo |
getTemplate(java.lang.String templateID,
boolean byName)
Return information about the specified workflow template. |
TemplateDefinitionInfo |
getTemplateDefinition(java.lang.String templateDefinitionID)
Return the specified workflow template definition. |
java.lang.String |
getTemplateDefinitionContent(java.lang.String definitionId)
Get the content of a workflow template definition. |
java.util.List |
getTemplateDefinitionInstances(java.lang.String templateDefinitionID,
java.lang.String orgID,
boolean bStarted,
java.util.Date from,
java.util.Date to,
int start,
int max)
List the instances of a workflow template definition in an organization. |
java.util.List |
getTemplateDefinitions(java.lang.String templateID)
List the definitions for a workflow template. |
java.util.List |
getTemplateInstances(java.lang.String templateID,
java.lang.String orgID,
boolean bStarted,
java.util.Date from,
java.util.Date to,
int start,
int max)
List the instances of a workflow template in an organization. |
java.util.List |
getTemplateOrgs(java.lang.String templateID)
List the organizations that have access to a workflow template. |
java.lang.String |
getTemplateOwner(java.lang.String templateDefinitionID)
Get the current owner of a workflow template. |
java.util.List |
getTemplates(java.lang.String orgID)
List the workflow templates for a specified organization. |
java.lang.String |
importPackage(byte[] pkg,
java.util.Map publishables,
java.lang.String orgID,
boolean activate,
java.lang.Object credential)
Import a package of publishable workflow objects specified by publishables. |
void |
lockTemplate(java.lang.String templateDefinitionID)
Place a persistent write lock on a workflow template. |
void |
ping()
A "dummy" method for the client to ping at regular intervals. |
java.util.Map |
readPackage(byte[] pkg,
java.lang.Object credential)
Reads a packaged workflow application, as created by the exportPackage(com.bea.wlpi.common.PublishPackage, java.lang.Object) method. |
void |
setInstanceVariable(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String variable,
java.lang.Object value)
Assign a value to a workflow instance variable. |
void |
setInstanceVariables(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.util.Map variables)
Assign values to workflow instance variables. |
void |
setPluginInstanceData(java.lang.String pluginName,
java.lang.String instanceID,
java.lang.Object value)
Set the plugin-supplied data associated with a workflow instance. |
void |
setTemplateDefinitionActive(java.lang.String templateDefinitionID,
boolean bActivate)
|
void |
setTemplateDefinitionContent(java.lang.String templateDefinitionID,
java.lang.String xml)
Set the content of a workflow template definition. |
void |
setTemplateNameOrgs(java.lang.String templateID,
java.lang.String name,
java.util.Collection orgs)
Deprecated. Use setTemplateOrgs(java.lang.String, java.util.Collection) and updateTemplate(com.bea.wlpi.common.TemplateInfo) . |
void |
setTemplateOrgs(java.lang.String templateID,
java.util.Collection orgs)
Specify which organizations have access to a workflow template. |
java.lang.String |
statisticsQuery(java.lang.String xml)
Run a statistics query. |
void |
taskAssign(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID,
java.lang.String assignTo,
boolean bRole,
boolean bLoadBalance)
Assign a task to a participant. |
void |
taskMarkDone(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Mark a task as complete. |
void |
taskSetProperties(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID,
int priority,
boolean doneWithoutDoit,
boolean doitIfDone,
boolean unmarkDone,
boolean modify,
boolean reassign)
Set the properties for a task instance. |
void |
taskUnassign(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Unassign a task. |
void |
taskUnmarkDone(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Mark a task as incomplete. |
void |
unlockTemplate(java.lang.String templateDefinitionID)
Unlock a previously locked template. |
void |
updateBusinessCalendar(BusinessCalendarInfo calendarInfo)
Update a business calendar. |
void |
updateBusinessOperation(java.lang.String busOpID,
ClassInvocationDescriptor descriptor)
Update a business operation. |
void |
updateBusinessOperation(java.lang.String busOpID,
EJBInvocationDescriptor descriptor)
Update a business operation. |
void |
updateEventKey(EventKeyInfo eventKeyInfo)
Update an event key. |
void |
updateReroute(java.lang.String rerouteID,
java.lang.String to,
int type,
java.sql.Timestamp effective,
java.sql.Timestamp expiry)
Update a task reroute. |
void |
updateReroute(java.lang.String rerouteID,
java.lang.String from,
java.lang.String to,
int type,
java.sql.Timestamp effective,
java.sql.Timestamp expiry)
Update a task reroute. |
void |
updateTemplate(TemplateInfo info)
Update a workflow template. |
java.lang.String |
workloadQuery(java.lang.String xml)
Run a workload query. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome,
getHandle,
getPrimaryKey,
isIdentical,
remove |
Field Detail |
public static final int TASKCOUNT_TOTAL
getTaskCounts
public static final int TASKCOUNT_PENDING
getTaskCounts
public static final int TASKCOUNT_INACTIVE
getTaskCounts
public static final int TASKCOUNT_COMPLETED
getTaskCounts
public static final int TASKCOUNT_OVERDUE
getTaskCounts
Method Detail |
public void ping() throws java.rmi.RemoteException
public java.lang.String createTemplate(java.lang.String name, java.util.Collection orgs) throws java.rmi.RemoteException, WorkflowException
createTemplate(String,String,Collection)
or createTemplate(String,String,Collection,Object)
name
- The template name.orgs
- IDs of organizations in which the template is accessible.createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String)
,
getTemplates(java.lang.String)
,
setTemplateNameOrgs(java.lang.String, java.lang.String, java.util.Collection)
public java.lang.String createTemplate(java.lang.String name, java.lang.String xml, java.util.Collection orgs) throws java.rmi.RemoteException, WorkflowException
name
- The template name.orgs
- IDs of organizations in which the template is accessible.xml
- Plugin data in xml form.createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String)
,
getTemplates(java.lang.String)
,
setTemplateNameOrgs(java.lang.String, java.lang.String, java.util.Collection)
public java.lang.String createTemplate(java.lang.String name, java.lang.String xml, java.util.Collection orgs, java.lang.Object requestID) throws java.rmi.RemoteException, WorkflowException
name
- The template name.orgs
- IDs of organizations in which the template is accessible.xml
- Plugin data in xml form.requestID
- The client request ID used to make the method
idempotent.createTemplate(String,String,Collection)
public TemplateInfo getTemplate(java.lang.String templateID, boolean byName) throws java.rmi.RemoteException, WorkflowException
templateID
- Name or ID of the template to retrieve.byName
- If true
, the templateID
parameter is the template's name rather than its ID.Messages.TEMPLATE_NOT_FOUND
.getTemplateDefinition(java.lang.String)
,
WorkflowException.getMessageNumber()
,
Messages
public java.util.List getTemplates(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- ID of the organization for which to retrieve templates.createTemplate(java.lang.String, java.util.Collection)
public void setTemplateNameOrgs(java.lang.String templateID, java.lang.String name, java.util.Collection orgs) throws java.rmi.RemoteException, WorkflowException
setTemplateOrgs(java.lang.String, java.util.Collection)
and updateTemplate(com.bea.wlpi.common.TemplateInfo)
.
templateID
- ID of the template.name
- The template name.orgs
- Collection of organization IDs.getTemplateOrgs(java.lang.String)
public void setTemplateOrgs(java.lang.String templateID, java.util.Collection orgs) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of the template.orgs
- Collection of organization IDs.getTemplateOrgs(java.lang.String)
public void updateTemplate(TemplateInfo info) throws java.rmi.RemoteException, WorkflowException
info
- Template information.setTemplateOrgs(java.lang.String, java.util.Collection)
,
getTemplateOrgs(java.lang.String)
public java.util.List getTemplateOrgs(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of the template.setTemplateNameOrgs(java.lang.String, java.lang.String, java.util.Collection)
public boolean checkForTemplateInstances(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of template for which to check instances.true
- if uncompleted instances exist.checkForTemplateDefinitionInstances(java.lang.String)
public java.sql.Timestamp findOldestTemplateInstance(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of template for which to check instances.public int getInstanceCount(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of template for which to check instances.int
- number of total instancesgetInstanceCount(String,boolean)
public int getInstanceCount(java.lang.String templateID, boolean completed) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of template for which to check instances.completed
- if true, return count of completed instances. If false, return count of running instancesint
- number of completed or running instancesgetInstanceCount(String)
public void deleteTemplate(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of template to delete.deleteTemplate(java.lang.String)
public void lockTemplate(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of template definition to lock.unlockTemplate(java.lang.String)
,
getTemplateOwner(java.lang.String)
public void unlockTemplate(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the template definition to unlock.lockTemplate(java.lang.String)
,
getTemplateOwner(java.lang.String)
public java.lang.String getTemplateOwner(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the template definition for which to retrieve the owner.lockTemplate(java.lang.String)
,
unlockTemplate(java.lang.String)
public java.lang.String createTemplateDefinition(java.lang.String templateID, java.lang.String name, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of the template in which to create the definition.name
- Name for the new definition.xml
- XML-format process definition.createTemplate(java.lang.String, java.util.Collection)
,
getTemplateDefinitions(java.lang.String)
,
setTemplateDefinitionContent(java.lang.String, java.lang.String)
public java.lang.String createTemplateDefinition(java.lang.String templateId, java.lang.String name, java.lang.String xml, java.lang.Object requestID) throws java.rmi.RemoteException, WorkflowException
templateId
- ID of the template in which to create the definition.name
- Name for the new definition.xml
- XML-format process definition.requestID
- The client request ID used to make the method
idempotent.createTemplateDefinition(String,String,String)
public TemplateDefinitionInfo getTemplateDefinition(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of the template definition to retrieve.includeContent
- If true
, includes the XML
content of the template definition.parsePluginData
- If true
, parse the plugin-supplied
template definition properties. This is necessary if the client wishes
to call the TemplateDefinitionInfo.getPluginData()
method on the
result.getTemplate(java.lang.String, boolean)
public java.util.List getTemplateDefinitions(java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
templateID
- ID of the template for which to retrieve the
definitions.createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String)
public boolean checkForTemplateDefinitionInstances(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of template definition to check.true
- if instances exist.checkForTemplateInstances(java.lang.String)
public void setTemplateDefinitionContent(java.lang.String templateDefinitionID, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of the template definition.xml
- Process definition (in XML format) compliant with
the
workflow template document type definition.createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String)
,
getTemplateDefinitionContent(java.lang.String)
public java.lang.String getTemplateDefinitionContent(java.lang.String definitionId) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of the template definition.setTemplateDefinitionContent(java.lang.String, java.lang.String)
public void deleteTemplateDefinition(java.lang.String templateDefinitionID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- ID of the template definition to delete.deleteTemplateDefinition(java.lang.String)
public java.util.List getTemplateInstances(java.lang.String templateID, java.lang.String orgID, boolean bStarted, java.util.Date from, java.util.Date to, int start, int max) throws java.rmi.RemoteException, WorkflowException
templateID
- The ID of the template.orgID
- The ID of the organization.bStarted
- Whether to query by start or completion date. If
true
, the query uses the instance start date; otherwise,
the completion date is used.from
- Lower bound of date range to include.to
- Upper bound of date range to include.start
- Offset in results at which returned list starts. This
enables clients to display long lists incrementally.max
- Maximum number of items to return. This enables clients to
limit the number of items to a subset of what could potentially be an
extremely long list.getTemplateDefinitionInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date, int, int)
public java.util.List getTemplateDefinitionInstances(java.lang.String templateDefinitionID, java.lang.String orgID, boolean bStarted, java.util.Date from, java.util.Date to, int start, int max) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the template definition.orgID
- The ID of the organization.bStarted
- Whether to query by start or completion date. If
true
, the query uses the instance start date; otherwise,
the completion date is used.from
- Lower bound of date range to include.to
- Upper bound of date range to include.start
- Offset in results at which returned list starts. This
enables clients to display long lists incrementally.max
- Maximum number of items to return. This enables clients to
limit the number of items to a subset of what could potentially be an
extremely long list.getTemplateInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date, int, int)
public java.util.List getInstanceTasks(java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
instanceID
- The ID of the workflow instance.getInstanceVariables(java.lang.String)
public java.util.List getInstanceVariables(java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
instanceID
- The ID of the workflow instance.WLPI Type | Java Class/Interface |
---|---|
boolean | java.lang.Boolean |
date | java.lang.Date |
double | java.lang.Double |
entity EJB | javax.ejb.Handle |
integer | java.lang.Integer or
java.lang.Long .
In versions of WebLogic Process Integrator prior to 2.0,
integer type variables are stored as
java.lang.Integer objects. WebLogic Process
Integrator 2.0 stores new instances of such values using
java.lang.Long objects. Existing instances may
assign either java.lang.Integer or
java.lang.Long values to their integer type
variables, depending on the actual expression that was evaluated
to generate the new value. A reference to an existing integer
variable instance (e.g., $MyExistingIntVariable) that has not
yet been updated under WebLogic Process Integrator 2.0 will
return a java.lang.Integer object, whereas an
expression such as (4 + 5 * $MyExistingIntVariable) will return
a java.lang.Long object.
Existing client programs that call this method and currently
cast the result java.lang.Integer will need to be modified to
test the value of an integer object and cast it either to
setInstanceVariable(java.lang.String, java.lang.String, java.lang.String, java.lang.Object) method expects to receive a
java.lang.Long object.
|
object | java.lang.Serializable |
session EJB | javax.ejb.Handle |
string | java.lang.String |
plugin types | java.lang.Serializable |
xml | byte[] : this is the XML document text, encoded
in UTF-8. Applications can either construct a
java.lang.String , or a
java.io.ByteArrayInputStream object on the byte
array, depending on how they wish to use the XML document.
Clients wishing to perform a DOM parse will need to specify
an entity resolver if the XML document contains a DOCTYPE or
other entity references. They can use
com.bea.eci.repository.helper.RepositoryResolver
if they wish to obtain the same resolution behavior as occurs
in the Studio and server; which is, entities are resolved
against the
XML repository.
|
setInstanceVariable(java.lang.String, java.lang.String, java.lang.String, java.lang.Object)
,
getInstanceTasks(java.lang.String)
public void setInstanceVariable(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String variable, java.lang.Object value) throws java.rmi.RemoteException, 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. |
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.variable
- 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.getInstanceVariables(java.lang.String)
public void setInstanceVariables(java.lang.String templateDefinitionID, java.lang.String instanceID, java.util.Map variables) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.variables
- Map containing variable names as the key and value objectsgetInstanceVariables(java.lang.String)
public java.lang.Object getPluginInstanceData(java.lang.String pluginName, java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
pluginName
- The reverse-DNS name of the plugin.instanceID
- The ID of the workflow instance.setPluginInstanceData(java.lang.String, java.lang.String, java.lang.Object)
public void setPluginInstanceData(java.lang.String pluginName, java.lang.String instanceID, java.lang.Object value) throws java.rmi.RemoteException, WorkflowException
pluginName
- The reverse-DNS name of the plugin.instanceID
- The ID of the workflow instance.value
- The value to store.getPluginInstanceData(java.lang.String, java.lang.String)
public void deleteInstance(java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
instanceID
- The ID of the workflow instance to delete.deleteTemplateInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)
,
deleteTemplateDefinitionInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)
public void deleteTemplateInstances(java.lang.String templateID, java.lang.String orgID, boolean bStarted, java.util.Date from, java.util.Date to) throws java.rmi.RemoteException, WorkflowException
templateID
- The ID of the workflow template for which to delete
instances.orgID
- The ID of the organization for which to delete instances.bStarted
- Whether to delete by start or completion date. If
true
, the query uses the instance start date; otherwise,
the completion date is used.from
- Lower bound of date range to include.to
- Upper bound of date range to include.deleteInstance(java.lang.String)
,
deleteTemplateDefinitionInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)
public void deleteTemplateDefinitionInstances(java.lang.String templateDefinitionID, java.lang.String orgID, boolean bStarted, java.util.Date from, java.util.Date to) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition for
which to delete instances.orgID
- The ID of the organization for which to delete instances.bStarted
- Whether to delete by start or completion date. If
true
, the query uses the instance start date; otherwise,
the completion date is used.from
- Lower bound of date range to include.to
- Upper bound of date range to include.deleteInstance(java.lang.String)
,
deleteTemplateInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)
public java.util.List getTasks(java.lang.String assigneeID, java.lang.String orgID, boolean role) throws java.rmi.RemoteException, WorkflowException
assigneeId
- The ID of the assignee for which to list tasks.orgID
- The ID of the organization.role
- true
if the assignee is a role,
false
if a user.public java.util.List getTasks(java.lang.String assigneeID, java.lang.String orgID, boolean role, boolean incompleteOnly, boolean sortAscending) throws java.rmi.RemoteException, WorkflowException
assigneeID
- The ID of the assignee for which to list tasks.orgID
- The ID of the organization.role
- true
if the assignee is a role,
false
if a user.incompleteOnly
- true
to return only tasks that have not completed,
false
to return all tasks.sortAscending
- true
to sort tasks in ascending time/date started order,
false
to sort in descending order.public int[] getTaskCounts(java.lang.String assigneeID, java.lang.String orgID, boolean role) throws java.rmi.RemoteException, WorkflowException
assigneeID
- The ID of the assignee for which to count tasks.orgID
- The ID of the organization.role
- true
if the assignee is a role,
false
if a user.element[TASKCOUNT_TOTAL] |
the total number of tasks assigned to the user/role. |
element[TASKCOUNT_PENDING] |
the number of those tasks which are pending. |
element[TASKCOUNT_INACTIVE] |
the number of those tasks which are inactive. |
element[TASKCOUNT_COMPLETED] |
the number of those tasks which are completed. |
element[TASKCOUNT_OVERDUE] |
the number of those tasks which are overdue. |
TASKCOUNT_TOTAL
,
TASKCOUNT_PENDING
,
TASKCOUNT_INACTIVE
,
TASKCOUNT_COMPLETED
,
TASKCOUNT_OVERDUE
public void taskMarkDone(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)
public void taskUnmarkDone(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.taskMarkDone(java.lang.String, java.lang.String, java.lang.String)
public void taskAssign(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, java.lang.String assignTo, boolean bRole, boolean bLoadBalance) throws java.rmi.RemoteException, WorkflowException
bLoadBalance
argument. This method is not idempotent.
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.assigneeId
- The ID of the participant to whom the task is to be
assigned.bRole
- true
if the assignee ID is that of a role,
false
if that of a user.bLoadBalance
- true
to request the system to perform
load-balancing within the specified role. This argument is ignored if
the bRole
argument is false
.public void taskUnassign(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.public void taskSetProperties(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, int priority, boolean doneWithoutDoit, boolean doitIfDone, boolean unmarkDone, boolean modify, boolean reassign) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.priority
- Default task instance priority (0=low, 1=medium or
2=high).doneWithoutDoit
- true
to permit a user to mark a task
instance as complete (by calling the taskMarkDone(java.lang.String, java.lang.String, java.lang.String)
method).doitIfDone
- true
to permit a user to execute
a task instance after it has been marked as complete.unmarkDone
- true
to permit a user to mark a task
instance as incomplete (by calling the taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)
method).modify
- true
to permit a user to modify a task
instance's runtime properties (by calling this method).reassign
- true
to permit a user to reassign a task
instance to another participant (by calling the taskAssign(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
method).public java.util.List getBusinessOperations() throws java.rmi.RemoteException, WorkflowException
public ClassDescriptor getClassDescriptor(java.lang.String className) throws java.rmi.RemoteException, WorkflowException
className
- Fully qualified Java class name for which to return
a descriptor.public java.lang.String addBusinessOperation(ClassInvocationDescriptor descriptor) throws java.rmi.RemoteException, WorkflowException
descriptor
- Meta-data describing method invocation on the
underlying Java class that implements the business operation.updateBusinessOperation(String, ClassInvocationDescriptor)
,
deleteBusinessOperation(String)
public void updateBusinessOperation(java.lang.String busOpID, ClassInvocationDescriptor descriptor) throws java.rmi.RemoteException, WorkflowException
busOpID
- The ID of the business operation to update.descriptor
- Meta-data describing method invocation on the
underlying Java class that implements the business operation.addBusinessOperation(ClassInvocationDescriptor)
,
deleteBusinessOperation(String)
public java.lang.String addBusinessOperation(EJBInvocationDescriptor descriptor) throws java.rmi.RemoteException, WorkflowException
descriptor
- Meta-data describing method invocation on the
underlying EJB that implements the business operation.updateBusinessOperation(String, EJBInvocationDescriptor)
,
deleteBusinessOperation(String)
public void updateBusinessOperation(java.lang.String busOpID, EJBInvocationDescriptor descriptor) throws java.rmi.RemoteException, WorkflowException
busOpID
- The ID of the business operation to update.descriptor
- Meta-data describing method invocation on the
underlying EJB that implements the business operation.addBusinessOperation(EJBInvocationDescriptor)
,
deleteBusinessOperation(String)
public void deleteBusinessOperation(java.lang.String busOpID) throws java.rmi.RemoteException, WorkflowException
busOpID
- The ID of the business operation to delete.addBusinessOperation(EJBInvocationDescriptor)
,
addBusinessOperation(ClassInvocationDescriptor)
public java.util.List getReroutes(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization for which to list reroutes.public java.lang.String addReroute(java.lang.String orgID, java.lang.String from, java.lang.String to, int type, java.sql.Timestamp effective, java.sql.Timestamp expiry) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization to which reroute applies.from
- The ID of the assignee whose tasks are to be rerouted.to
- The ID of the participant to whom the rerouted tasks will be
assigned.type
- Type of reroute:
TYPE_USER,
TYPE_USERINROLE or
TYPE_ROLEeffective
- Date/time at which reroute becomes effective.expiry
- Date/time at which reroute ceases to be effective.updateReroute(java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp)
,
deleteReroute(java.lang.String)
public void updateReroute(java.lang.String rerouteID, java.lang.String to, int type, java.sql.Timestamp effective, java.sql.Timestamp expiry) throws java.rmi.RemoteException, WorkflowException
rerouteID
- The ID of the reroute to update.to
- The ID of the participant to whom the rerouted tasks will be
assigned.type
- Type of reroute:
TYPE_USER,
TYPE_USERINROLE or
TYPE_ROLEeffective
- Date/time at which reroute becomes effective.expiry
- Date/time at which reroute ceases to be effective.addReroute(java.lang.String, java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp)
,
deleteReroute(java.lang.String)
public void updateReroute(java.lang.String rerouteID, java.lang.String from, java.lang.String to, int type, java.sql.Timestamp effective, java.sql.Timestamp expiry) throws java.rmi.RemoteException, WorkflowException
rerouteID
- The ID of the reroute to update.from
- The ID of the participant from whom the rerouted tasks will
be reassigned.to
- The ID of the participant to whom the rerouted tasks will be
assigned.type
- Type of reroute:
TYPE_USER,
TYPE_USERINROLE or
TYPE_ROLEeffective
- Date/time at which reroute becomes effective.expiry
- Date/time at which reroute ceases to be effective.addReroute(java.lang.String, java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp)
,
deleteReroute(java.lang.String)
public void deleteReroute(java.lang.String rerouteID) throws java.rmi.RemoteException, WorkflowException
rerouteID
- The ID of the reroute to delete.addReroute(java.lang.String, java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp)
,
updateReroute(java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp)
public java.util.List getEventKeyInfo() throws java.rmi.RemoteException, WorkflowException
public void addEventKey(EventKeyInfo eventKeyInfo) throws java.rmi.RemoteException, WorkflowException
eventKeyInfo
- Values for the new event key.updateEventKey(com.bea.wlpi.common.EventKeyInfo)
,
deleteEventKey(com.bea.wlpi.common.EventKeyInfo)
public void updateEventKey(EventKeyInfo eventKeyInfo) throws java.rmi.RemoteException, WorkflowException
eventKeyInfo
- Updated values for the event key.addEventKey(com.bea.wlpi.common.EventKeyInfo)
,
deleteEventKey(com.bea.wlpi.common.EventKeyInfo)
public void deleteEventKey(EventKeyInfo eventKeyInfo) throws java.rmi.RemoteException, WorkflowException
eventKeyInfo
- The event key to delete.addEventKey(com.bea.wlpi.common.EventKeyInfo)
,
updateEventKey(com.bea.wlpi.common.EventKeyInfo)
public java.lang.String workloadQuery(java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
xml
- The query specification, which must conform to the
workload query
document type definition.statisticsQuery(java.lang.String)
public java.lang.String statisticsQuery(java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
xml
- The query specification, which must conform to the
statistics query
document type definition.workloadQuery(java.lang.String)
public java.util.List getAllBusinessCalendars(boolean includeDefinition) throws java.rmi.RemoteException, WorkflowException
includeDefinition
- true
to include the XML calendar
specification in the returned objects.getBusinessCalendarDefinition(java.lang.String)
public java.lang.String addBusinessCalendar(BusinessCalendarInfo calendarInfo) throws java.rmi.RemoteException, WorkflowException
calendarInfo
- Values for the new business calendar.updateBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo)
,
deleteBusinessCalendar(java.lang.String)
public void updateBusinessCalendar(BusinessCalendarInfo calendarInfo) throws java.rmi.RemoteException, WorkflowException
calendarInfo
- Updated values for the business calendar.addBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo)
,
deleteBusinessCalendar(java.lang.String)
public void deleteBusinessCalendar(java.lang.String calendarID) throws java.rmi.RemoteException, WorkflowException
calendarID
- The ID of the business calendar to delete.addBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo)
,
updateBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo)
public java.lang.String getBusinessCalendarDefinition(java.lang.String calendarID) throws java.rmi.RemoteException, WorkflowException
calendarID
- The ID of the business calendar for which definition is
required.getAllBusinessCalendars(boolean)
public java.util.List getCallableWorkflows(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization for which to list workflows.public java.lang.String findCallableWorkflow(java.lang.String templateName, java.lang.String templateID, java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
templateName
- name of the template to retrieve definitions from.templateID
- ID of the template to retrieve definitions from.orgID
- The ID of the organization.public java.util.Map readPackage(byte[] pkg, java.lang.Object credential) throws java.rmi.RemoteException, WorkflowException
exportPackage(com.bea.wlpi.common.PublishPackage, java.lang.Object)
method. This method can be called by design-time
clients in order to display the contents of the package, to enable users
to select the objects they wish to import.
This method is idempotent.
pkg
- A byte array which is the image of a JAR file containing the
exported objects.credential
- An object containing the password if the package is
password protected, null
otherwise.Publishable
interface. The values in the map are hetereogenous
java.util.List
objects containing
XxxInfo
objects of a type to match the corresponding key:
public java.lang.String importPackage(byte[] pkg, java.util.Map publishables, java.lang.String orgID, boolean activate, java.lang.Object credential) throws java.rmi.RemoteException, WorkflowException
pkg
- A byte array which is the image of a JAR file containing all
exported objects.publishables
- A Map with the following structure:Map keys | Publishable types as defined in com.bea.wlpi.common.Publishable. |
Map values | List of Objects of type com.bea.wlpi.common.PackageEntry |
orgID
- The ID of the organization to which the package is
being imported.activate
- indicates whether the imported workflows should be
activated on import or not.credential
- An object containing the password if the package is
password protected, null otherwise.public byte[] exportPackage(PublishPackage publishPackage, java.lang.Object credential) throws java.rmi.RemoteException, WorkflowException
publishPackage
- An object of type com.bea.wlpi.common.PublishPackage,
which contains the entries of type com.bea.wlpi.common.PackageEntry
to be exported into the Jar package.credential
- An object containing the password if the package is password
protected, null otherwise.public InstanceInfo getInstanceInfo(java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
instanceID
- The ID of the workflow instance.public void setTemplateDefinitionActive(java.lang.String templateDefinitionID, boolean bActivate) throws java.rmi.RemoteException, WorkflowException
orgId
- the organization id that is searched for workflows
referenced by the action start workflow.templateDefinitionID
- The ID of the workflow template definition
that will be activated or deactivated.bActivate
- indicates whether the workflow template definition
should be activated (true
) or deactivated
(false
).
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |