Package org.kie.server.client
Interface UIServicesClient
-
- All Known Implementing Classes:
UIServicesClientImpl
public interface UIServicesClient
-
-
Field Summary
Fields Modifier and Type Field Description static String
ANY_FORM
static String
BOOTSTRAP_FORM_RENDERER
static String
FORM_MODELLER_TYPE
static String
FORM_TYPE
static String
FREE_MARKER_TYPE
static String
PATTERNFLY_FORM_RENDERER
static String
WORKBENCH_FORM_RENDERER
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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
getProcessFormByType(String containerId, String processId, String formType)
Returns process form for given process id that resides in given container - without filtering values by languageString
getProcessFormByType(String containerId, String processId, String language, String formType)
Returns process form for given process id that resides in given containerString
getProcessImage(String containerId, String processId)
Returns process image (svg) of the given process id that belongs to given containerString
getProcessInstanceImage(String containerId, Long processInstanceId)
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given containerString
getProcessInstanceImageCustomColor(String containerId, Long processInstanceId, String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor, String activeAsyncNodeBorderColor)
Returns process image (svg) with annotated active and completed nodes for given process instance that belongs to given containerString
getProcessRawForm(String containerId, String processId)
Returns process form for given process id that resides in given container - without filtering values by language.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.String
getTaskFormAsUser(String containerId, Long taskId, String language, String userId)
Returns task form for given task id that belongs to given container as specified user.String
getTaskFormByType(String containerId, Long taskId, String formType)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language.String
getTaskFormByType(String containerId, Long taskId, String language, String formType)
Returns task form for given task id that belongs to given container.String
getTaskFormByTypeAsUser(String containerId, Long taskId, String language, String formType, String userId)
Returns task form for given task id that belongs to given container as specified user.String
getTaskRawForm(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
getTaskRawFormAsUser(String containerId, Long taskId, String userId)
Returns task form for given task id that belongs to given container as specified user as raw content - without filtering values by language.String
renderCaseForm(String containerId, String caseDefinitionId)
Returns case form for given case definition that resides in given container - completely rendered so the output is HTMLString
renderCaseForm(String containerId, String caseDefinitionId, String renderer)
Returns case form for given case definition id that resides in given container - completely rendered so the output is HTMLString
renderProcessForm(String containerId, String processId)
Returns process form for given process id that resides in given container - completely rendered so the output is HTMLString
renderProcessForm(String containerId, String processId, String renderer)
Returns process form for given process id that resides in given container - completely rendered so the output is HTMLString
renderTaskForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTMLString
renderTaskForm(String containerId, Long taskId, String renderer)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTMLvoid
setResponseHandler(ResponseHandler responseHandler)
Override default response handler to change interaction pattern.
-
-
-
Field Detail
-
FORM_MODELLER_TYPE
static final String FORM_MODELLER_TYPE
- See Also:
- Constant Field Values
-
FORM_TYPE
static final String FORM_TYPE
- See Also:
- Constant Field Values
-
FREE_MARKER_TYPE
static final String FREE_MARKER_TYPE
- See Also:
- Constant Field Values
-
ANY_FORM
static final String ANY_FORM
- See Also:
- Constant Field Values
-
BOOTSTRAP_FORM_RENDERER
static final String BOOTSTRAP_FORM_RENDERER
- See Also:
- Constant Field Values
-
PATTERNFLY_FORM_RENDERER
static final String PATTERNFLY_FORM_RENDERER
- See Also:
- Constant Field Values
-
WORKBENCH_FORM_RENDERER
static final String WORKBENCH_FORM_RENDERER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProcessForm
String getProcessForm(String containerId, String processId, String language)
Returns process form for given process id that resides in given container. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idlanguage
- language that form should be filtered for- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getProcessFormByType
String getProcessFormByType(String containerId, String processId, String language, String formType)
Returns process form for given process id that resides in given container- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- 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. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- string representation (json or xml depending on client marshaling selection) of the process form
-
getProcessRawForm
String getProcessRawForm(String containerId, String processId)
Returns process form for given process id that resides in given container - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- string representation of the process form without any marshalling
-
getProcessFormByType
String getProcessFormByType(String containerId, String processId, String formType)
Returns process form for given process id that resides in given container - without filtering values by language- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- 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. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered for- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormByType
String getTaskFormByType(String containerId, Long taskId, String language, String formType)
Returns task form for given task id that belongs to given container.- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- 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. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskRawForm
String getTaskRawForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- string representation of the task form without any marshalling
-
getTaskFormByType
String getTaskFormByType(String containerId, Long taskId, String formType)
Returns task form for given task id that belongs to given container as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType- Parameters:
containerId
- container identifier where task residestaskId
- unique task idformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormAsUser
String getTaskFormAsUser(String containerId, Long taskId, String language, String userId)
Returns task form for given task id that belongs to given container as specified user. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormForUserByType Introduced to allow client to take advantage of bypass auth user connecting to server.- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered foruserId
- userId making the request to bypass auth user- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskFormByTypeAsUser
String getTaskFormByTypeAsUser(String containerId, Long taskId, String language, String formType, String userId)
Returns task form for given task id that belongs to given container as specified user. Introduced to allow client to take advantage of bypass auth user connecting to server.- Parameters:
containerId
- container identifier where task residestaskId
- unique task idlanguage
- language that form should be filtered forformType
- type of form to be returned (FORM - default (form modeler), FRM - v7 forms, FTL - freemarker template)userId
- userId making the request to bypass auth user- Returns:
- string representation (json or xml depending on client marshaling selection) of the task form
-
getTaskRawFormAsUser
String getTaskRawFormAsUser(String containerId, Long taskId, String userId)
Returns task form for given task id that belongs to given container as specified user as raw content - without filtering values by language. It returns default form type which is (FORM - build with form modeler). If there is a need to select the type use #getProcessFormByType Introduced to allow client to take advantage of bypass auth user connecting to server.- Parameters:
containerId
- container identifier where task residestaskId
- unique task iduserId
- userId making the request to bypass auth user- Returns:
- string representation of the task form without any marshalling
-
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 residesprocessId
- 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 residesprocessInstanceId
- unique process instance id- Returns:
- svg (xml) representing process image annotated with active (in red) and completed (in grey) nodes
-
getProcessInstanceImageCustomColor
String getProcessInstanceImageCustomColor(String containerId, Long processInstanceId, String completeNodeColor, String completeNodeBorderColor, String activeNodeBorderColor, String activeAsyncNodeBorderColor)
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 residesprocessInstanceId
- unique process instance idcompleteNodeColor
- process instance image complete node colorcompleteNodeBorderColor
- process instance image complete node border coloractiveNodeBorderColor
- process instance image active node border coloractiveAsyncNodeBorderColor
- process instance image active async node border color- Returns:
- svg (xml) representing process image annotated with custom colors
-
renderProcessForm
String renderProcessForm(String containerId, String processId)
Returns process form for given process id that resides in given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where process residesprocessId
- unique process id- Returns:
- HTML representation of the process form
-
renderProcessForm
String renderProcessForm(String containerId, String processId, String renderer)
Returns process form for given process id that resides in given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where process residesprocessId
- unique process idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the process form
-
renderCaseForm
String renderCaseForm(String containerId, String caseDefinitionId)
Returns case form for given case definition that resides in given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where process residescaseDefinitionId
- unique case definition id- Returns:
- HTML representation of the process form
-
renderCaseForm
String renderCaseForm(String containerId, String caseDefinitionId, String renderer)
Returns case form for given case definition id that resides in given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where process residescaseDefinitionId
- unique case definition idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the process form
-
renderTaskForm
String renderTaskForm(String containerId, Long taskId)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where task residestaskId
- unique task id- Returns:
- HTML representation of the task form
-
renderTaskForm
String renderTaskForm(String containerId, Long taskId, String renderer)
Returns task form for given task id that belongs to given container - completely rendered so the output is HTML- Parameters:
containerId
- container identifier where task residestaskId
- unique task idrenderer
- name of the renderer to be used to produce the HTML- Returns:
- HTML representation of the task form
-
setResponseHandler
void setResponseHandler(ResponseHandler responseHandler)
Override default response handler to change interaction pattern. Applies only to JMS based integration.- Parameters:
responseHandler
-
-
-