org.imixs.workflow.webservices.soap
Class WorkflowManagerClient

java.lang.Object
  org.imixs.workflow.webservices.soap.WorkflowManagerClient

All Implemented Interfaces:

WorkflowManagerService

public class WorkflowManagerClient
extends Object
implements WorkflowManagerService

The WorkflowManagerClient is a WebSerice Client for the Imixs WorkflowManager Service based on the Apache Axiom Framework. The WorkflowManagerClient uses the helper class org.imixs.workflow.service.client.axiom.ServiceClient to establish SOAP Connections

Author:

Ralph Soika

See Also:

org.imixs.workflow.RestClient.client.axiom.ServiceClient

Constructor Summary

WorkflowManagerClient(String aServiceEndpoint, String aUserName, String aPassword)

Method Summary

XMLItemCollection	createWorkItem(int processID)
String	getNameSpace()
ServiceClient	getServiceClient()
XMLItemCollection	getWorkItem(String workitemID) This method finds and returns an existing workitem (Map) by the unique or workitem ID.
EntityCollection	getWorkList(String name, int start, int count) This method returns a collection of workitems (Maps) belonging to a specified name.
EntityCollection	getWorkListByCreator(String name, int start, int count) This method returns a collection of workitems (Maps) belonging to a specified creator of a workitem.
EntityCollection	getWorkListByGroup(String name, int start, int count) This method returns a collection of workitems (Maps) belonging to a specified workflow group.
EntityCollection	getWorkListByProcessID(int id, int start, 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.
boolean	isAuthor(String workitemID)
XMLItemCollection	processWorkItem(XMLItemCollection workitem, int activityID) This method processes the forwarded workitem (Map) through the specified ActivityInstance.
void	removeWorkItem(String workitemid) This method removes a workitem.
void	setNameSpace(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowManagerClient

public WorkflowManagerClient(String aServiceEndpoint,
                             String aUserName,
                             String aPassword)

Method Detail

getNameSpace

public String getNameSpace()

setNameSpace

public void setNameSpace(String s)

getServiceClient

public ServiceClient getServiceClient()

createWorkItem

public XMLItemCollection createWorkItem(int processID)
                                 throws Exception

Throws:

Exception

getWorkItem

public XMLItemCollection getWorkItem(String workitemID)
                              throws Exception

Description copied from interface: WorkflowManagerService

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.

Specified by:

getWorkItem in interface WorkflowManagerService

Returns:

workitem

Throws:

Exception

getWorkList

public EntityCollection getWorkList(String name,
                                    int start,
                                    int count)
                             throws Exception

Description copied from interface: WorkflowManagerService

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.

Specified by:

getWorkList in interface WorkflowManagerService

Returns:

Throws:

Exception

getWorkListByCreator

public EntityCollection getWorkListByCreator(String name,
                                             int start,
                                             int count)
                                      throws Exception

Description copied from interface: WorkflowManagerService

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

Specified by:

getWorkListByCreator in interface WorkflowManagerService

Returns:

Throws:

Exception

getWorkListByGroup

public EntityCollection getWorkListByGroup(String name,
                                           int start,
                                           int count)
                                    throws Exception

Description copied from interface: WorkflowManagerService

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

Specified by:

getWorkListByGroup in interface WorkflowManagerService

Returns:

Throws:

Exception

getWorkListByRef

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

Description copied from interface: WorkflowManagerService

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.

Specified by:

getWorkListByRef in interface WorkflowManagerService

Parameters:

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

Returns:

List of workitems

Throws:

Exception

getWorkListByProcessID

public EntityCollection getWorkListByProcessID(int id,
                                               int start,
                                               int count)
                                        throws Exception

Description copied from interface: WorkflowManagerService

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.

Specified by:

getWorkListByProcessID in interface WorkflowManagerService

Returns:

Throws:

Exception

isAuthor

public boolean isAuthor(String workitemID)
                 throws Exception

Throws:

Exception

processWorkItem

public XMLItemCollection processWorkItem(XMLItemCollection workitem,
                                         int activityID)
                                  throws Exception

Description copied from interface: WorkflowManagerService

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.

Specified by:

processWorkItem in interface WorkflowManagerService

Returns:

Throws:

Exception

removeWorkItem

public void removeWorkItem(String workitemid)
                    throws Exception

Description copied from interface: WorkflowManagerService

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

Specified by:

removeWorkItem in interface WorkflowManagerService

Throws:

Exception