|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.apps.workflow.WorkflowExecutionMO | +--com.ibm.itim.apps.workflow.WorkflowProcessMO
Class that provides management capabilities for a workflow process.
Constructor Summary | |
WorkflowProcessMO(PlatformContext platform,
javax.security.auth.Subject subject,
long id)
Constructs the the managed object with a platform context and a subject. |
Method Summary | |
void |
abort()
Aborts the process. |
void |
auditEvent(EventAudit event)
Places the given event in the audit trail (history) of the execution object. |
void |
execute(WorkflowSearchResultsMO results,
java.util.Locale locale)
Executes the search using the configured parameters. |
java.util.Collection |
getActivities()
Returns the activities that are part of this process. |
WorkflowActivityMO |
getActivity(java.lang.String designId)
Returns the activity of the process with the given ID. |
WorkflowActivityMO |
getActivity(java.lang.String designId,
int index)
Returns the activity of the process with the given ID and given index of the iteration of the loop the activity is involved in. |
java.util.Collection |
getChildren()
Returns the child processes of this process (if any). |
WorkflowProcess |
getData()
Returns the value object holding details about this process. |
java.util.List |
getHistory()
Returns the history, or the audit trail for this process. |
WorkflowProcessMO |
getParent()
Returns the parent process of this process (if any). |
Methods inherited from class com.ibm.itim.apps.workflow.WorkflowExecutionMO |
getID |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WorkflowProcessMO(PlatformContext platform, javax.security.auth.Subject subject, long id)
platform
- PlatformContext holding platform connection information.subject
- Subject representing the authenticated caller.id
- long representing the id of the process.Method Detail |
public void abort() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if an error was encountered trying
to abort the process.public java.util.Collection getActivities() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the process's
activities.public void execute(WorkflowSearchResultsMO results, java.util.Locale locale) throws java.rmi.RemoteException, ApplicationException
results
- WorkflowSearchResultsMO to hold the results of the search. Note,
if the WorkflowSearchResultsMO object was constructed using a
different user context, that context will be changed to
match the context of this object.locale
- User's locale to be sorted with.java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to execute the search.
This is most likely caused by an invalid
parameter in the request.public java.util.List getHistory() throws java.rmi.RemoteException, ApplicationException
getHistory
in class WorkflowExecutionMO
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if an error was encountered trying
to retrieve the history.public void auditEvent(EventAudit event) throws java.rmi.RemoteException, ApplicationException
auditEvent
in class WorkflowExecutionMO
event
- EventAudit representing the audited event.WorkflowException
- Thrown if an error was encountered trying
to audit the event.public WorkflowActivityMO getActivity(java.lang.String designId) throws java.rmi.RemoteException, ApplicationException
id
- String ID of the activity to retrieve as defined at design time.java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the activity
because of an invalid id.public WorkflowActivityMO getActivity(java.lang.String designId, int index) throws java.rmi.RemoteException, ApplicationException
id
- String ID of the activity to retrieve as defined at design time.index
- Index of the loop iteration.java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the activity
because of an invalid id or loop index.public WorkflowProcessMO getParent() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the process's
parent process.public java.util.Collection getChildren() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the process's
child processes.public WorkflowProcess getData() throws java.rmi.RemoteException, ApplicationException
java.rmi.RemoteException
- Thrown if unable to communicate with platform.ApplicationException
- Thrown if unable to retrieve the process's
value object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |