public class ActivitiRestClient extends Object
| Constructor and Description |
|---|
ActivitiRestClient(String portM,
String hostnameM) |
| Modifier and Type | Method and Description |
|---|---|
String |
activateProcessInstanceById(String processDefintionID)
Method used to activate a process instance
|
String[] |
addNewCommentOnTaskByTaskId(String taskID,
String comment)
Method used to add a new comment to a task
|
String |
claimTaskByTaskId(String taskID)
Method to claim task by a user
|
String |
delegateTaskByTaskId(String taskID)
Mehtod to delegate a task to certain user
|
String |
deleteProcessInstanceByID(String processInstanceId)
Method used to remove/delete a process instance
|
String |
deleteTaskByTaskId(String taskId,
boolean cascadeHistory,
String deleteReason)
Method to delete a task
|
String[] |
deployBPMNPackage(String filePath,
String fileName)
This Method is used to deploy BPMN packages to the BPMN Server
|
String[] |
findProcessDefinitionInfoById(String deploymentID)
Method to find the definitionID which is necessary to start a process instance
|
String[] |
findTaskIdByProcessInstanceID(String processInstanceId)
Method used to find task by using the process instance ID
|
String |
getAssigneeByTaskId(String taskID)
Method to get the asignee of a task
|
String |
getCommentByTaskIdAndCommentId(String taskID,
String commentID)
This method is used to get the comment by comment id and task id
|
String |
getDelegationsStateByTaskId(String taskID)
Method used to get the delegation state of a task
|
String[] |
getDeploymentInfoById(String deploymentID)
Method is used to acquire deployment details using the deployment ID
|
String |
getSuspendedStateOfProcessInstanceByID(String processInstanceID)
Method is used to find thw suspended state of a process instance
|
String[] |
getValueOfVariableOfProcessInstanceById(String processInstanceId,
String variable)
Method to get the value of a variable in the process instance
|
String |
resolveTaskByTaskId(String taskID)
Method used to resolve a task
|
String |
searchProcessInstanceByDefintionID(String processDefintionID)
Methods used to test/search if the specify process instance is present
|
String[] |
startProcessInstanceByDefintionID(String processDefintionID)
Method use to instantiate a process instance using the definition ID
|
String[] |
suspendProcessInstanceById(String processInstanceID)
Method used to suspend a process instance
|
String |
unDeployBPMNPackage(String deploymentID)
Method is used to undeploy/remove a deployment from the server
|
String |
validateProcessInstanceById(String processDefinitionID)
This method is used to validate/check if the process instance is present or not
|
public ActivitiRestClient(String portM, String hostnameM) throws MalformedURLException
MalformedURLExceptionpublic String[] deployBPMNPackage(String filePath, String fileName) throws RestClientException, IOException, org.json.JSONException
fileName - The name of the Package to be deployedfilePath - The location of the BPMN package to be deployedIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String[] getDeploymentInfoById(String deploymentID) throws RestClientException, IOException, org.json.JSONException
deploymentID - Deployment ID of the BPMN PackageIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String unDeployBPMNPackage(String deploymentID) throws IOException
deploymentID - used to identify the deployment to be removedIOExceptionpublic String[] findProcessDefinitionInfoById(String deploymentID) throws IOException, org.json.JSONException
deploymentID - the deployment id is used to identify the deployment uniquelyIOExceptionorg.json.JSONExceptionpublic String searchProcessInstanceByDefintionID(String processDefintionID) throws IOException
processDefintionID - used to start a processInstanceIOExceptionpublic String validateProcessInstanceById(String processDefinitionID) throws IOException, org.json.JSONException, RestClientException
processDefinitionID - used to identify the process instanceIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String[] startProcessInstanceByDefintionID(String processDefintionID) throws IOException, org.json.JSONException, RestClientException
processDefintionID - used to start a processInstanceIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String activateProcessInstanceById(String processDefintionID) throws IOException
processDefintionID - used to identify the process instance to activateIOExceptionpublic String[] suspendProcessInstanceById(String processInstanceID) throws IOException, org.json.JSONException, RestClientException
processInstanceID - used to identify the process instance to suspendIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String getSuspendedStateOfProcessInstanceByID(String processInstanceID) throws IOException, org.json.JSONException
processInstanceID - used to identify the process instanceIOExceptionorg.json.JSONExceptionpublic String[] getValueOfVariableOfProcessInstanceById(String processInstanceId, String variable) throws IOException, org.json.JSONException
processInstanceId - To identify the process instancevariable - to identify the variable nameIOExceptionorg.json.JSONExceptionpublic String deleteProcessInstanceByID(String processInstanceId) throws IOException
processInstanceId - used to identify a process instanceIOExceptionpublic String getDelegationsStateByTaskId(String taskID) throws IOException, org.json.JSONException
taskID - used to identify the taskIOExceptionorg.json.JSONExceptionpublic String resolveTaskByTaskId(String taskID) throws IOException
taskID - used to identify the taskIOExceptionpublic String getAssigneeByTaskId(String taskID) throws IOException, org.json.JSONException
taskID - used to identify the taskIOExceptionorg.json.JSONExceptionpublic String getCommentByTaskIdAndCommentId(String taskID, String commentID) throws IOException, org.json.JSONException
taskID - used to identify the task where the comment is madecommentID - used to identify the comment uniquelyIOExceptionorg.json.JSONExceptionpublic String[] findTaskIdByProcessInstanceID(String processInstanceId) throws IOException, org.json.JSONException
processInstanceId - used to identify task through a process instanceIOExceptionorg.json.JSONExceptionpublic String claimTaskByTaskId(String taskID) throws IOException
taskID - used to identify the task to be claimedIOExceptionpublic String delegateTaskByTaskId(String taskID) throws IOException
taskID - used to identify the task to be delegatedIOExceptionpublic String[] addNewCommentOnTaskByTaskId(String taskID, String comment) throws RestClientException, IOException, org.json.JSONException
taskID - used to identify the taskcomment - comment to be addedIOExceptionorg.json.JSONExceptionRestClientExceptionpublic String deleteTaskByTaskId(String taskId, boolean cascadeHistory, String deleteReason) throws IOException
taskId - used to identify a taskcascadeHistory - boolean to either delete the task history or notdeleteReason - reason for deleteing the taskIOExceptionCopyright © 2015 WSO2 Inc. All rights reserved.