com.bea.wlpi.server.admin
Interface Admin

public interface Admin

extends javax.ejb.EJBObject

Provides WebLogic Process Integrator administrative functions.

See Also:

AdminHome

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 definitionId) Check whether the specified workflow template definition has any instances.
boolean	checkForTemplateInstances(java.lang.String templateId) Check whether a workflow template has any instances.
java.lang.String	createTemplate(java.lang.String name, java.util.Collection orgs) 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.
void	deleteBusinessCalendar(java.lang.String calendarId) Delete a business calendar.
void	deleteBusinessOperation(java.lang.String id) 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 id) Delete a task reroute.
void	deleteTemplate(java.lang.String templateId) Delete a workflow template.
void	deleteTemplateDefinition(java.lang.String definitionId) 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.
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.
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.
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.util.List	getReroutes(java.lang.String orgId) List the task reroutes defined within an organization.
java.util.List	getTasks(java.lang.String user, java.lang.String orgId, boolean role) List the tasks assigned to a participant in an organization.
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 id) Get the current owner of a workflow template.
java.util.List	getTemplates(java.lang.String orgId) List the workflow templates for a specified organization.
void	lockTemplate(java.lang.String id) Place a persistent write lock on a workflow template.
void	ping() A "dummy" method for the client to ping.
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	setTemplateDefinitionContent(java.lang.String definitionId, 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) 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	taskUnmarkDone(java.lang.String templateDefinitionId, java.lang.String instanceId, java.lang.String taskId) Mark a task as incomplete.
void	unlockTemplate(java.lang.String id) Unlock a previously locked template.
void	updateBusinessCalendar(BusinessCalendarInfo calendarInfo) Update a business calendar.
void	updateBusinessOperation(java.lang.String id, ClassInvocationDescriptor descriptor) Update a business operation.
void	updateBusinessOperation(java.lang.String id, EJBInvocationDescriptor descriptor) Update a business operation.
void	updateEventKey(EventKeyInfo eventKeyInfo) Update an event key.
void	updateReroute(java.lang.String id, java.lang.String to, int type, java.sql.Timestamp effective, java.sql.Timestamp expiry) Update a task reroute.
java.lang.String	workloadQuery(java.lang.String xml) Run a workload query.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

ping

public void ping()
          throws java.rmi.RemoteException

A "dummy" method for the client to ping. This is to circumvent the WebLogic Server session bean timeout.

Throws:

java.rmi.RemoteException - if a communications error occurred.

createTemplate

public java.lang.String createTemplate(java.lang.String name,
                                       java.util.Collection orgs)
                                throws java.rmi.RemoteException,
                                       WorkflowException

Create a workflow template with the specified name.

Parameters:

orgs - IDs of organizations in which the template is accessible.

name - The template name.

Returns:

The ID of the new template.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String), getTemplates(java.lang.String), setTemplateNameOrgs(java.lang.String, java.lang.String, java.util.Collection)

createTemplateDefinition

public java.lang.String createTemplateDefinition(java.lang.String templateId,
                                                 java.lang.String name,
                                                 java.lang.String xml)
                                          throws java.rmi.RemoteException,
                                                 WorkflowException

Create a definition for a workflow template, using the name and content supplied.

Parameters:

templateId - ID of the template in which to create the definition.

name - Name for the new definition.

xml - XML-format process definition.

Returns:

The ID of the new template definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

createTemplate(java.lang.String, java.util.Collection), getTemplateDefinitions(java.lang.String), setTemplateDefinitionContent(java.lang.String, java.lang.String)

getTemplates

public java.util.List getTemplates(java.lang.String orgId)
                            throws java.rmi.RemoteException,
                                   WorkflowException

List the workflow templates for a specified organization.

Parameters:

orgId - ID of the organization for which to retrieve templates.

Returns:

A list of TemplateInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

createTemplate(java.lang.String, java.util.Collection)

getTemplateDefinitions

public java.util.List getTemplateDefinitions(java.lang.String templateId)
                                      throws java.rmi.RemoteException,
                                             WorkflowException

List the definitions for a workflow template.

Parameters:

templateId - ID of the template for which to retrieve the definitions.

Returns:

A list of TemplateDefinitionInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String)

checkForTemplateInstances

public boolean checkForTemplateInstances(java.lang.String templateId)
                                  throws java.rmi.RemoteException,
                                         WorkflowException

Check whether a workflow template has any instances.

Parameters:

templateId - ID of template for which to check instances.

Returns:

true - if instances exist.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

checkForTemplateDefinitionInstances(java.lang.String)

checkForTemplateDefinitionInstances

public boolean checkForTemplateDefinitionInstances(java.lang.String definitionId)
                                            throws java.rmi.RemoteException,
                                                   WorkflowException

Check whether the specified workflow template definition has any instances.

Parameters:

templateDefinitionId - ID of template definition to check.

Returns:

true - if instances exist.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

checkForTemplateInstances(java.lang.String)

setTemplateNameOrgs

public void setTemplateNameOrgs(java.lang.String templateId,
                                java.lang.String name,
                                java.util.Collection orgs)
                         throws java.rmi.RemoteException,
                                WorkflowException

Specify which organizations have access to a workflow template.

Parameters:

orgs - Collection of organization IDs.

templateId - ID of the template.

name - The template name.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getTemplateOrgs(java.lang.String)

getTemplateOrgs

public java.util.List getTemplateOrgs(java.lang.String templateId)
                               throws java.rmi.RemoteException,
                                      WorkflowException

List the organizations that have access to a workflow template.

Parameters:

templateId - ID of the template.

Returns:

A list of organization IDs.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

setTemplateNameOrgs(java.lang.String, java.lang.String, java.util.Collection)

setTemplateDefinitionContent

public void setTemplateDefinitionContent(java.lang.String definitionId,
                                         java.lang.String xml)
                                  throws java.rmi.RemoteException,
                                         WorkflowException

Set the content of a workflow template definition. The content (i.e., the business process definition) is expressed in XML format.

Parameters:

templateDefinitionId - ID of the template definition.

xml - Process definition (in XML format) compliant with the workflow template document type definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

createTemplateDefinition(java.lang.String, java.lang.String, java.lang.String), getTemplateDefinitionContent(java.lang.String)

getTemplateDefinitionContent

public java.lang.String getTemplateDefinitionContent(java.lang.String definitionId)
                                              throws java.rmi.RemoteException,
                                                     WorkflowException

Get the content of a workflow template definition. The content (i.e., the business process definition) is expressed in XML format.

Parameters:

templateDefinitionId - ID of the template definition.

Returns:

Process definition (in XML format) compliant with the workflow template document type definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

setTemplateDefinitionContent(java.lang.String, java.lang.String)

deleteTemplateDefinition

public void deleteTemplateDefinition(java.lang.String definitionId)
                              throws java.rmi.RemoteException,
                                     WorkflowException

Delete a workflow template definition. This method also deletes all instances thereof.

Parameters:

templateId - ID of the template to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

deleteTemplateDefinition(java.lang.String)

deleteTemplate

public void deleteTemplate(java.lang.String templateId)
                    throws java.rmi.RemoteException,
                           WorkflowException

Delete a workflow template. This method also deletes all definitions and instances thereof.

Parameters:

templateDefinitionId - ID of template definition to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

deleteTemplate(java.lang.String)

lockTemplate

public void lockTemplate(java.lang.String id)
                  throws java.rmi.RemoteException,
                         WorkflowException

Place a persistent write lock on a workflow template.

Parameters:

templateId - ID of template to lock.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

unlockTemplate(java.lang.String), getTemplateOwner(java.lang.String)

unlockTemplate

public void unlockTemplate(java.lang.String id)
                    throws java.rmi.RemoteException,
                           WorkflowException

Unlock a previously locked template.

Parameters:

templateId - The ID of the template to unlock.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if the user submitting the request does not have a lock on the template or if an exception prevented the request from being completed

See Also:

lockTemplate(java.lang.String), getTemplateOwner(java.lang.String)

getTemplateOwner

public java.lang.String getTemplateOwner(java.lang.String id)
                                  throws java.rmi.RemoteException,
                                         WorkflowException

Get the current owner of a workflow template.

Parameters:

templateId - The ID of the template for which to retrieve the owner.

Returns:

The The ID of the current template owner.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

lockTemplate(java.lang.String), unlockTemplate(java.lang.String)

getTemplateInstances

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

List the instances of a workflow template in an organization.

Parameters:

orgId - The ID of the organization.

templateId - The ID of the template.

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.

Returns:

A list of InstanceInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getTemplateDefinitionInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date, int, int)

getTemplateDefinitionInstances

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

List the instances of a workflow template definition in an organization.

Parameters:

orgId - The ID of the organization.

templateDefinitionId - The ID of the template definition.

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.

Returns:

A list of InstanceInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getTemplateInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date, int, int)

getInstanceTasks

public java.util.List getInstanceTasks(java.lang.String instanceId)
                                throws java.rmi.RemoteException,
                                       WorkflowException

List the tasks in a workflow instance.

Parameters:

instanceId - The ID of the workflow instance.

Returns:

A list of TaskInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getInstanceVariables(java.lang.String)

getInstanceVariables

public java.util.List getInstanceVariables(java.lang.String instanceId)
                                    throws java.rmi.RemoteException,
                                           WorkflowException

List the variables in a workflow instance.

Parameters:

instanceId - The ID of the workflow instance.

Returns:

A list of VariableInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getInstanceTasks(java.lang.String)

setInstanceVariable

public void setInstanceVariable(java.lang.String templateDefinitionId,
                                java.lang.String instanceId,
                                java.lang.String variable,
                                java.lang.Object value)
                         throws java.rmi.RemoteException,
                                WorkflowException

Assign a value to a workflow instance variable.

Parameters:

templateDefinitionId - The ID of the workflow template definition.

instanceId - The ID of the workflow instance.

variable - Name of the variable to set.

value - Value to assign variable.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

deleteInstance

public void deleteInstance(java.lang.String instanceId)
                    throws java.rmi.RemoteException,
                           WorkflowException

Delete a workflow instance.

Parameters:

instanceId - The ID of the workflow instance to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

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)

deleteTemplateInstances

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

Delete instances of a workflow template in an organization.

Parameters:

orgId - The ID of the organization for which to delete instances.

templateId - The ID of the workflow template 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.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

deleteInstance(java.lang.String), deleteTemplateDefinitionInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)

deleteTemplateDefinitionInstances

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

Delete instances of a workflow template definition in an organization.

Parameters:

orgId - The ID of the organization for which to delete instances.

templateDefinitionId - The ID of the workflow template definition 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.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

deleteInstance(java.lang.String), deleteTemplateInstances(java.lang.String, java.lang.String, boolean, java.util.Date, java.util.Date)

getTasks

public java.util.List getTasks(java.lang.String user,
                               java.lang.String orgId,
                               boolean role)
                        throws java.rmi.RemoteException,
                               WorkflowException

List the tasks assigned to a participant in an organization.

Parameters:

orgId - The ID of the organization.

assigneeId - The ID of the assignee for which to list tasks.

role - true if the assignee is a role, false if a user.

Returns:

A list of TaskInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

taskMarkDone

public void taskMarkDone(java.lang.String templateDefinitionId,
                         java.lang.String instanceId,
                         java.lang.String taskId)
                  throws java.rmi.RemoteException,
                         WorkflowException

Mark a task as complete. Calling this method results in the task's "completed" date being set to the current time and in the execution of any actions defined for the task's "completed" event.

Parameters:

templateDefinitionId - The ID of the workflow template definition.

instanceId - The ID of the workflow instance.

taskId - The ID of the task instance.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if the method is called by a client process and the task's properties do not permit it to be marked complete or if an exception prevented the request from being completed.

See Also:

taskUnmarkDone(java.lang.String, java.lang.String, java.lang.String)

taskUnmarkDone

public void taskUnmarkDone(java.lang.String templateDefinitionId,
                           java.lang.String instanceId,
                           java.lang.String taskId)
                    throws java.rmi.RemoteException,
                           WorkflowException

Mark a task as incomplete. The default implementation clears the task's "completed" date but does not cause the execution of the actions defined for the task's "started" event.

Parameters:

templateDefinitionId - The ID of the workflow template definition.

instanceId - The ID of the workflow instance.

taskId - The ID of the task instance.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if the method is called by a client process and the task's properties do not permit it to be marked incomplete or if an exception prevented the request from being completed.

See Also:

taskMarkDone(java.lang.String, java.lang.String, java.lang.String)

taskAssign

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

Assign a task to a participant. The actual participant to whom the system assigns the task depends on: 1.) whether any task reroutes are currently in force for the nominated assignee and 2.) the value of the bLoadBalance argument.

Parameters:

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.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if the method is called by a client process and the task's properties do not permit it to be reassigned or if an exception prevented the request from being completed.

taskSetProperties

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

Set the properties for a task instance.

Parameters:

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).

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if the mthod is called by a client process and the task's properties do not permit it to be modified or if an exception prevented the request from being completed

getBusinessOperations

public java.util.List getBusinessOperations()
                                     throws java.rmi.RemoteException,
                                            WorkflowException

List the currently defined business operations.

Returns:

A list of ClassInvocationDescriptor or EJBInvocationDescriptor objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

getClassDescriptor

public ClassDescriptor getClassDescriptor(java.lang.String className)
                                   throws java.rmi.RemoteException,
                                          WorkflowException

Get a server side class descriptor.

Parameters:

className - Fully qualified Java class name for which to return a descriptor.

Returns:

Meta-data for the specified class.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

addBusinessOperation

public java.lang.String addBusinessOperation(ClassInvocationDescriptor descriptor)
                                      throws java.rmi.RemoteException,
                                             WorkflowException

Create a new business operation implemented by a Java class.

Parameters:

descriptor - Meta-data describing method invocation on the underlying Java class that implements the business operation.

Returns:

The ID of the new business operation.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

updateBusinessOperation(String, ClassInvocationDescriptor), deleteBusinessOperation(String)

updateBusinessOperation

public void updateBusinessOperation(java.lang.String id,
                                    ClassInvocationDescriptor descriptor)
                             throws java.rmi.RemoteException,
                                    WorkflowException

Update a business operation.

Parameters:

id - The ID of the business operation to update.

descriptor - Meta-data describing method invocation on the underlying Java class that implements the business operation.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addBusinessOperation(ClassInvocationDescriptor), deleteBusinessOperation(String)

addBusinessOperation

public java.lang.String addBusinessOperation(EJBInvocationDescriptor descriptor)
                                      throws java.rmi.RemoteException,
                                             WorkflowException

Create a new business operation implemented by an EJB.

Parameters:

descriptor - Meta-data describing method invocation on the underlying EJB that implements the business operation.

Returns:

The ID of the new business operation.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

updateBusinessOperation(String, EJBInvocationDescriptor), deleteBusinessOperation(String)

updateBusinessOperation

public void updateBusinessOperation(java.lang.String id,
                                    EJBInvocationDescriptor descriptor)
                             throws java.rmi.RemoteException,
                                    WorkflowException

Update a business operation.

Parameters:

id - The ID of the business operation to update.

descriptor - Meta-data describing method invocation on the underlying EJB that implements the business operation.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addBusinessOperation(EJBInvocationDescriptor), deleteBusinessOperation(String)

deleteBusinessOperation

public void deleteBusinessOperation(java.lang.String id)
                             throws java.rmi.RemoteException,
                                    WorkflowException

Delete a business operation.

Parameters:

id - The ID of the business operation to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addBusinessOperation(EJBInvocationDescriptor), addBusinessOperation(ClassInvocationDescriptor)

getReroutes

public java.util.List getReroutes(java.lang.String orgId)
                           throws java.rmi.RemoteException,
                                  WorkflowException

List the task reroutes defined within an organization.

Parameters:

orgId - The ID of the organization for which to list reroutes.

Returns:

A list of RerouteInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

addReroute

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

Create a new task reroute.

Parameters:

orgId - The ID of the organization to which reroute applies.

fromId - The ID of the assignee whose tasks are to be rerouted.

toId - The ID of the participant to whom the rerouted tasks will be assigned.

type - Type of reroute: TYPE_USER, TYPE_USERINROLE or TYPE_ROLE

effective - Date/time at which reroute becomes effective.

expiry - Date/time at which reroute ceases to be effective.

Returns:

The ID of the new Reroute object.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

updateReroute(java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp), deleteReroute(java.lang.String)

updateReroute

public void updateReroute(java.lang.String id,
                          java.lang.String to,
                          int type,
                          java.sql.Timestamp effective,
                          java.sql.Timestamp expiry)
                   throws java.rmi.RemoteException,
                          WorkflowException

Update a task reroute.

Parameters:

id - The ID of the reroute to update.

toId - The ID of the participant to whom the rerouted tasks will be assigned.

type - Type of reroute: TYPE_USER, TYPE_USERINROLE or TYPE_ROLE

effective - Date/time at which reroute becomes effective.

expiry - Date/time at which reroute ceases to be effective.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addReroute(java.lang.String, java.lang.String, java.lang.String, int, java.sql.Timestamp, java.sql.Timestamp), deleteReroute(java.lang.String)

deleteReroute

public void deleteReroute(java.lang.String id)
                   throws java.rmi.RemoteException,
                          WorkflowException

Delete a task reroute.

Parameters:

id - The ID of the reroute to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

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)

getEventKeyInfo

public java.util.List getEventKeyInfo()
                               throws java.rmi.RemoteException,
                                      WorkflowException

List the event keys defined within the workflow system.

Returns:

A list of EventKeyInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

addEventKey

public void addEventKey(EventKeyInfo eventKeyInfo)
                 throws java.rmi.RemoteException,
                        WorkflowException

Create a new event key.

Parameters:

eventKeyInfo - Values for the new event key.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

updateEventKey(com.bea.wlpi.common.EventKeyInfo), deleteEventKey(com.bea.wlpi.common.EventKeyInfo)

updateEventKey

public void updateEventKey(EventKeyInfo eventKeyInfo)
                    throws java.rmi.RemoteException,
                           WorkflowException

Update an event key.

Parameters:

eventKeyInfo - Updated values for the event key.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addEventKey(com.bea.wlpi.common.EventKeyInfo), deleteEventKey(com.bea.wlpi.common.EventKeyInfo)

deleteEventKey

public void deleteEventKey(EventKeyInfo eventKeyInfo)
                    throws java.rmi.RemoteException,
                           WorkflowException

Delete an event key.

Parameters:

eventKeyId - The ID of the event key to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addEventKey(com.bea.wlpi.common.EventKeyInfo), updateEventKey(com.bea.wlpi.common.EventKeyInfo)

workloadQuery

public java.lang.String workloadQuery(java.lang.String xml)
                               throws java.rmi.RemoteException,
                                      WorkflowException

Run a workload query.

Parameters:

xml - The query specification, which must conform to the workload query document type definition.

Returns:

The workload report (in XML format) compliant with the workload report document type definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

statisticsQuery(java.lang.String)

statisticsQuery

public java.lang.String statisticsQuery(java.lang.String xml)
                                 throws java.rmi.RemoteException,
                                        WorkflowException

Run a statistics query.

Parameters:

xml - The query specification, which must conform to the statistics query document type definition.

Returns:

The statistics report (in XML format) compliant with the statistics report document type definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

workloadQuery(java.lang.String)

getAllBusinessCalendars

public java.util.List getAllBusinessCalendars(boolean includeDefinition)
                                       throws java.rmi.RemoteException,
                                              WorkflowException

List the business calendars defined in the workflow system.

Parameters:

includeDefinition - true to include the XML calendar specification in the returned objects.

Returns:

A list of BusinessCalendarInfo objects.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getBusinessCalendarDefinition(java.lang.String)

addBusinessCalendar

public java.lang.String addBusinessCalendar(BusinessCalendarInfo calendarInfo)
                                     throws java.rmi.RemoteException,
                                            WorkflowException

Create a new business calendar.

Parameters:

calendarInfo - Values for the new business calendar.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

updateBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo), deleteBusinessCalendar(java.lang.String)

updateBusinessCalendar

public void updateBusinessCalendar(BusinessCalendarInfo calendarInfo)
                            throws java.rmi.RemoteException,
                                   WorkflowException

Update a business calendar.

Parameters:

calendarInfo - Updated values for the business calendar.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo), deleteBusinessCalendar(java.lang.String)

deleteBusinessCalendar

public void deleteBusinessCalendar(java.lang.String calendarId)
                            throws java.rmi.RemoteException,
                                   WorkflowException

Delete a business calendar.

Parameters:

calendarId - The ID of the business calendar to delete.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

addBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo), updateBusinessCalendar(com.bea.wlpi.common.BusinessCalendarInfo)

getBusinessCalendarDefinition

public java.lang.String getBusinessCalendarDefinition(java.lang.String calendarId)
                                               throws java.rmi.RemoteException,
                                                      WorkflowException

Return the definition of a business calendar.

Parameters:

calendarId - The ID of the business calendar for which definition is required.

Returns:

The business calendar definition (in XML format) compliant with the business calendar document type definition.

Throws:

java.rmi.RemoteException - if a communications error occurred.

WorkflowException - if an exception prevented the request from being completed.

See Also:

getAllBusinessCalendars(boolean)