org.imixs.workflow.webservices.soap
Interface WorkflowManagerService

All Known Implementing Classes:

WorkflowManagerClient

public interface WorkflowManagerService

Service Interface for the WorkflowManager. This Service Interface supports methods to create, process and find process instantces. This interface should be used by a workflow service server component. Some methods are mapped directly to the org.imixs.workflow.WorkflowManager Interface. In addition there are getter methods defined which should be used by workflow clients to display a set of workitems.

Version:

1.3

Author:

Ralph Soika

Method Summary

XMLItemCollection	getWorkItem(String uniqueid) This method finds and returns an existing workitem (Map) by the unique or workitem ID.
EntityCollection	getWorkList(String name, int startpos, int count) This method returns a collection of workitems (Maps) belonging to a specified name.
EntityCollection	getWorkListByCreator(String name, int startpos, int count) This method returns a collection of workitems (Maps) belonging to a specified creator of a workitem.
EntityCollection	getWorkListByGroup(String name, int startpos, int count) This method returns a collection of workitems (Maps) belonging to a specified workflow group.
EntityCollection	getWorkListByProcessID(int aID, int startpos, int count) This method returns a collection of workitems (Maps) belonging to a specified process id form the workflow model.
EntityCollection	getWorkListByRef(String aref, int startpos, int count) This method returns a collection of workitems (Maps) belonging to a specified workitem identified by the attribute $UniqueIDRef.
XMLItemCollection	processWorkItem(XMLItemCollection workitem, int activityid) This method processes the forwarded workitem (Map) through the specified ActivityInstance.
void	removeWorkItem(String uniqueid) This method removes a workitem.

Method Detail

getWorkItem

XMLItemCollection getWorkItem(String uniqueid)
                              throws Exception

This method finds and returns an existing workitem (Map) by the unique or workitem ID. The implementation has to accept both the transfer of a $uniqueID and a $workItemID. Therefore the $uniqueID and $workitemID must be unique in the wokflow system the web service belongs to.The web service has to care that the CallerPrincipal has read access rights for the workitem to be returned. If the caller has insufficient rights to read the requested workitem, the method returns an emtpy worktiem or "null" and dose not return a fault exception. This is for security reasons so a client can not "test" if a workitem exists.

Parameters:

uniqueid -

attrlist -

Returns:

workitem

Throws:

Exception

processWorkItem

XMLItemCollection processWorkItem(XMLItemCollection workitem,
                                  int activityid)
                                  throws Exception

This method processes the forwarded workitem (Map) through the specified ActivityInstance. For this purpose, the workitem is processed by the workflowManager the Web Service belongs to. The Web Service has to identify the workitem by its $uniqueID attribute and processes the workitem with the defined activityID. After that the workitem should be stored into the workflow Systemt by the implemented persistence strategy. The method returns the processed workitem (Map) which contains the new attributes assigend by the workflowmanager during processing. The web service has to care that the CallerPrincipal has write access rights for the workitem to be procressed. If an attribute currently existing in the stored workitem is not supported in the workitem thranfered by the method the service should not remove this item. So if an attribute is emtpy the current attribute will be changed but if the attribute is not transmitted the workitem will not be changed or removed. To remove a attribute of a workitem permanently use the plugin technology. If the caller has insufficient rights to write the workitem, the method returns a fault exception that the user has insufficient write access.

Parameters:

workitem -

activityid -

attrlist -

Returns:

Throws:

Exception

removeWorkItem

void removeWorkItem(String uniqueid)
                    throws Exception

This method removes a workitem. The is identified by the unique or workitem ID. The implementation has to accept both the transfer of a $uniqueID and a $workItemID. Therefore the $uniqueID and $workitemID must be unique in the wokflow system the web service belongs to. If a $workitemID is supported the method should also remove all existing versions of this workitem. The web service has to care that the CallerPrincipal has write access rights for the workitem to be procressed. The method dose not return a value. The method returns a fault exception if the user has insufficient access to remove the workitem

Parameters:

uniqueid -

Throws:

Exception

getWorkList

EntityCollection getWorkList(String name,
                             int startpos,
                             int count)
                             throws Exception

This method returns a collection of workitems (Maps) belonging to a specified name. The name is a username or role contained in the nameworkflowWriteAccess attribute of the workitem. The web service should return a subset of a collection if the start and count parameters differ form the value -1. The web service has to care that the CallerPrincipal has read access rights for each workitem to be returned. The method returns only workitems the call has sufficient read access for.

Parameters:

name -

startpos -

count -

Returns:

Throws:

Exception

getWorkListByGroup

EntityCollection getWorkListByGroup(String name,
                                    int startpos,
                                    int count)
                                    throws Exception

This method returns a collection of workitems (Maps) belonging to a specified workflow group. The behaivor is simmilar to the method getWorkList.

Parameters:

name -

startpos -

count -

attrlist -

Returns:

Throws:

Exception

getWorkListByProcessID

EntityCollection getWorkListByProcessID(int aID,
                                        int startpos,
                                        int count)
                                        throws Exception

This method returns a collection of workitems (Maps) belonging to a specified process id form the workflow model. The behaivor is simmilar to the method getWorkList.

Parameters:

aID -

startpos -

count -

attrlist -

Returns:

Throws:

Exception

getWorkListByCreator

EntityCollection getWorkListByCreator(String name,
                                      int startpos,
                                      int count)
                                      throws Exception

This method returns a collection of workitems (Maps) belonging to a specified creator of a workitem. The behaivor is simmilar to the method getWorkList.

Parameters:

name -

startpos -

count -

attrlist -

Returns:

Throws:

Exception

getWorkListByRef

EntityCollection getWorkListByRef(String aref,
                                  int startpos,
                                  int count)
                                  throws Exception

This method returns a collection of workitems (Maps) belonging to a specified workitem identified by the attribute $UniqueIDRef. The behaivor of this Mehtod is simmilar to the method getWorkList.

Parameters:

aref - A unique reference to another workitem inside a database *

startpos -

count -

attrlist -

Returns:

List of workitems

Throws:

Exception