org.imixs.melman

Class WorkflowClient

java.lang.Object

org.imixs.melman.WorkflowClient

public class WorkflowClient
extends Object

This ServiceClient is a WebService REST Client which encapsulate the communication with a REST web serice based on the Imixs Workflow REST API. The Implementation is based on the JAXB API 2.0.

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE
static String	DEFAULT_TYPE

Constructor Summary

Constructors

Constructor and Description
WorkflowClient(String base_uri) Initialize the client by a BASE_URL.

Method Summary

Modifier and Type	Method and Description
List<org.imixs.workflow.ItemCollection>	getCustomResource(String uri) Returns the custom data list by uri
String	getItems()
int	getPageIndex()
int	getPageSize()
String	getSortBy()
List<org.imixs.workflow.ItemCollection>	getTaskListByCreator(String userid) Returns the current task list by creator
List<org.imixs.workflow.ItemCollection>	getTaskListByOwner(String userid) Returns the current task list by owner
String	getType() retruns the document type.
List<org.imixs.workflow.ItemCollection>	getWorkflowEventsByWorkitem(org.imixs.workflow.ItemCollection workitem) Returns the current task list by owner
org.imixs.workflow.ItemCollection	getWorkitem(String uniqueid) Returns a single workItem instance by UniqueID.
boolean	isSortReverse()
org.imixs.workflow.ItemCollection	processWorkitem(org.imixs.workflow.ItemCollection workitem) Process a single workitem instance.
void	registerClientRequestFilter(javax.ws.rs.client.ClientRequestFilter filter) Register a ClientRequestFilter instance.
void	setItems(String items)
void	setPageIndex(int pageIndex)
void	setPageSize(int pageSize)
void	setSortBy(String sortBy)
void	setSortOrder(String sortBy, boolean sortReverse)
void	setSortReverse(boolean sortReverse)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_TYPE

public static final String DEFAULT_TYPE

See Also:

Constant Field Values

Constructor Detail

WorkflowClient

public WorkflowClient(String base_uri)

Initialize the client by a BASE_URL.

Parameters:

base_uri -

Method Detail

registerClientRequestFilter

public void registerClientRequestFilter(javax.ws.rs.client.ClientRequestFilter filter)

Register a ClientRequestFilter instance.

Parameters:

filter - - request filter instance.

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getPageIndex

public int getPageIndex()

setPageIndex

public void setPageIndex(int pageIndex)

getItems

public String getItems()

setItems

public void setItems(String items)

getType

public String getType()

retruns the document type. The default value is "workitem"

Returns:

setType

public void setType(String type)

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

isSortReverse

public boolean isSortReverse()

setSortReverse

public void setSortReverse(boolean sortReverse)

setSortOrder

public void setSortOrder(String sortBy,
                         boolean sortReverse)

processWorkitem

public org.imixs.workflow.ItemCollection processWorkitem(org.imixs.workflow.ItemCollection workitem)

Process a single workitem instance. If the workitem is not yet managed by the workflow manger a new instance will be created.

Parameters:

workitem - - a ItemCollection representing the workitem.

Returns:

updated workitem instance

getWorkitem

public org.imixs.workflow.ItemCollection getWorkitem(String uniqueid)

Returns a single workItem instance by UniqueID.

Parameters:

uniqueid -

items -

Returns:

workitem

getTaskListByCreator

public List<org.imixs.workflow.ItemCollection> getTaskListByCreator(String userid)

Returns the current task list by creator

Parameters:

userid -

items -

Returns:

task list for given user

getTaskListByOwner

public List<org.imixs.workflow.ItemCollection> getTaskListByOwner(String userid)

Returns the current task list by owner

Parameters:

userid -

items -

Returns:

task list for given user

getWorkflowEventsByWorkitem

public List<org.imixs.workflow.ItemCollection> getWorkflowEventsByWorkitem(org.imixs.workflow.ItemCollection workitem)

Returns the current task list by owner

Parameters:

userid -

items -

Returns:

task list for given user

getCustomResource

public List<org.imixs.workflow.ItemCollection> getCustomResource(String uri)

Returns the custom data list by uri

Parameters:

userid -

items -

Returns:

task list for given user