org.kie.server.client

Interface UIServicesClient

All Known Implementing Classes:

UIServicesClientImpl

public interface UIServicesClient

Method Summary

Modifier and Type	Method and Description
String	getProcessForm(String containerId, String processId) Returns process form for given process id that resides in given container - without filtering values by language
String	getProcessForm(String containerId, String processId, String language) Returns process form for given process id that resides in given container
String	getProcessImage(String containerId, String processId) Returns process image (svg) of the given process id that belongs to given container
String	getProcessInstanceImage(String containerId, Long processInstanceId) Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given container
String	getTaskForm(String containerId, Long taskId) Returns task form for given task id that belongs to given container as raw content - without filtering values by language
String	getTaskForm(String containerId, Long taskId, String language) Returns task form for given task id that belongs to given container
void	setResponseHandler(ResponseHandler responseHandler) Override default response handler to change interaction pattern.

Method Detail

getProcessForm

String getProcessForm(String containerId,
                      String processId,
                      String language)

Returns process form for given process id that resides in given container

Parameters:

containerId - container identifier where process resides

processId - unique process id

language - language that form should be filtered for

Returns:

string representation (json or xml depending on client marshaling selection) of the process form

getProcessForm

String getProcessForm(String containerId,
                      String processId)

Returns process form for given process id that resides in given container - without filtering values by language

Parameters:

containerId - container identifier where process resides

processId - unique process id

Returns:

string representation (json or xml depending on client marshaling selection) of the process form

getTaskForm

String getTaskForm(String containerId,
                   Long taskId,
                   String language)

Returns task form for given task id that belongs to given container

Parameters:

containerId - container identifier where task resides

taskId - unique task id

language - language that form should be filtered for

Returns:

string representation (json or xml depending on client marshaling selection) of the task form

getTaskForm

String getTaskForm(String containerId,
                   Long taskId)

Returns task form for given task id that belongs to given container as raw content - without filtering values by language

Parameters:

containerId - container identifier where task resides

taskId - unique task id

Returns:

string representation (json or xml depending on client marshaling selection) of the task form

getProcessImage

String getProcessImage(String containerId,
                       String processId)

Returns process image (svg) of the given process id that belongs to given container

Parameters:

containerId - container identifier where process resides

processId - unique process id

Returns:

svg (xml) representing process image

getProcessInstanceImage

String getProcessInstanceImage(String containerId,
                               Long processInstanceId)

Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given container

Parameters:

containerId - container identifier where process resides

processInstanceId - unique process instance id

Returns:

svg (xml) representing process image annotated with active (in red) and completed (in grey) nodes

setResponseHandler

void setResponseHandler(ResponseHandler responseHandler)

Override default response handler to change interaction pattern. Applies only to JMS based integration.

Parameters:

responseHandler -