com.tsgrp.opencontent.core.workflow

Class RESTWorkflow

java.lang.Object

com.tsgrp.opencontent.rest.RESTService

com.tsgrp.opencontent.core.workflow.RESTWorkflow

@Controller
 @RequestMapping(value="/workflow")
public class RESTWorkflow
extends RESTService

Field Summary

Fields inherited from class com.tsgrp.opencontent.rest.RESTService

CHUNKSIZE, HEADER_ACCEPT_LANGUAGE, HEADER_ACCEPT_RANGES, HEADER_CACHE_CONTROL, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_RANGE, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_IF_MODIFIED_SINCE, HEADER_LAST_MODIFIED, HEADER_LOCATION, HEADER_RANGE, HEADER_USER_AGENT, MULTIPART_BYTERANGES_BOUNDRY, MULTIPART_BYTERANGES_BOUNDRY_END, MULTIPART_BYTERANGES_BOUNDRY_SEP, MULTIPART_BYTERANGES_HEADER

Constructor Summary

Constructors

Constructor and Description
RESTWorkflow()

Method Summary

Modifier and Type	Method and Description
java.util.List<WorkflowInstance>	abortOrphanedWorkflows(java.lang.String paramTicket, java.lang.String cookieTicket)
void	acquireTask(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId)
void	cancelWorkflow(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String workflowInstanceId, java.lang.String deleteReason, java.lang.String taskId)
void	completeTask(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId, java.util.Map<java.lang.String,java.lang.Object> params)
void	deleteDeployedWorkflow(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String wfDefId)
java.lang.String	deployWorkflow(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String workflowDefinitionFileName)
java.util.List<WorkflowInstance>	getAllWorkflowInstances(java.lang.String paramTicket, java.lang.String cookieTicket)
java.util.List<WorkflowInstanceSnapshot>	getAllWorkflowInstanceSnapshots(java.lang.String paramTicket, java.lang.String cookieTicket)
java.util.List<WorkflowInstanceSnapshot>	getAllWorkflowInstanceSnapshotsByGroup(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String groups)
java.util.List<WorkflowInstance>	getOrphanedWorkflows(java.lang.String paramTicket, java.lang.String cookieTicket)
java.util.Map<java.lang.String,java.lang.Object>	getStartFormKey(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String processDefinitionId)
TaskInstance	getTask(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId)
TaskInstance[]	getTasks(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName)
java.util.List<java.lang.String>	getTasksByContent(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String objectId)
TaskInstance[]	getTasksForUserByContent(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String objectId, java.lang.String userLoginName)
TaskInstance[]	getUnclaimedTasks(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String associatedContentId)
java.util.List<WorkflowDefinition>	getWorkflowDefinitions(java.lang.String paramTicket, java.lang.String cookieTicket)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getWorkflowDefinitionTasks(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String processDefinitionId)
WorkflowInstance	getWorkflowInstance(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String workflowInstanceId, java.lang.String taskId)
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getWorkflowInstanceInfo(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String objectId)
java.util.List<WorkflowInstanceSnapshot>	getWorkflowInstanceSnapshot(java.lang.String paramTicket, java.lang.String userLoginName, int numPerPage, java.lang.String cookieTicket)
WorkflowPackage	getWorkflowPackage(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String workflowInstanceId, java.lang.String taskId)
void	releaseTask(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId)
java.lang.Boolean	setTaskAssignee(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId, java.lang.String userLoginName)
java.lang.Boolean	setTaskStatus(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String taskId, java.lang.String status)
java.lang.String	startWorkflow(java.lang.String paramTicket, java.lang.String cookieTicket, java.lang.String workflowName, java.util.Map props)

Methods inherited from class com.tsgrp.opencontent.rest.RESTService

contentNotProcessed, contentNotReady, genericException, notAuth, notFoundException, notSupported, objectLocked, ocConflict, ocConflict, ocForbidden, ocRuntimeException, resolveTicket

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTWorkflow

public RESTWorkflow()

Method Detail

getWorkflowDefinitions

@RequestMapping(value="/workflowDefinitions",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowDefinition> getWorkflowDefinitions(@RequestParam(value="ticket",required=false)
                                                                                                                                                             java.lang.String paramTicket,
                                                                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                                                                             java.lang.String cookieTicket)

deployWorkflow

@RequestMapping(value="/workflowDefinitions",
                method=POST)
 @ResponseBody
public java.lang.String deployWorkflow(@RequestParam(value="ticket",required=false)
                                                                                                                                    java.lang.String paramTicket,
                                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                                    java.lang.String cookieTicket,
                                                                                                                                    @RequestParam
                                                                                                                                    java.lang.String workflowDefinitionFileName)

deleteDeployedWorkflow

@RequestMapping(value="/workflowdefinitions/{wfDefId}",
                method=DELETE)
 @ResponseBody
public void deleteDeployedWorkflow(@RequestParam(value="ticket",required=false)
                                                                                                                                            java.lang.String paramTicket,
                                                                                                                                            @CookieValue(value="ticket",required=false)
                                                                                                                                            java.lang.String cookieTicket,
                                                                                                                                            @PathVariable
                                                                                                                                            java.lang.String wfDefId)

startWorkflow

@RequestMapping(value="/startworkflow",
                method=POST)
 @ResponseBody
public java.lang.String startWorkflow(@RequestParam(value="ticket",required=false)
                                                                                                                             java.lang.String paramTicket,
                                                                                                                             @CookieValue(value="ticket",required=false)
                                                                                                                             java.lang.String cookieTicket,
                                                                                                                             @RequestParam
                                                                                                                             java.lang.String workflowName,
                                                                                                                             @RequestBody
                                                                                                                             java.util.Map props)

acquireTask

@RequestMapping(value="/acquiretask",
                method=GET)
 @ResponseBody
public void acquireTask(@RequestParam(value="ticket",required=false)
                                                                                                            java.lang.String paramTicket,
                                                                                                            @CookieValue(value="ticket",required=false)
                                                                                                            java.lang.String cookieTicket,
                                                                                                            @RequestParam
                                                                                                            java.lang.String taskId)

releaseTask

@RequestMapping(value="/releasetask",
                method=GET)
 @ResponseBody
public void releaseTask(@RequestParam(value="ticket",required=false)
                                                                                                            java.lang.String paramTicket,
                                                                                                            @CookieValue(value="ticket",required=false)
                                                                                                            java.lang.String cookieTicket,
                                                                                                            @RequestParam
                                                                                                            java.lang.String taskId)

completeTask

@RequestMapping(value="/completetask",
                method=POST)
 @ResponseBody
public void completeTask(@RequestParam(value="ticket",required=false)
                                                                                                               java.lang.String paramTicket,
                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                               java.lang.String cookieTicket,
                                                                                                               @RequestParam
                                                                                                               java.lang.String taskId,
                                                                                                               @RequestBody
                                                                                                               java.util.Map<java.lang.String,java.lang.Object> params)

setTaskAssignee

@RequestMapping(value="/settaskassignee",
                method=GET)
 @ResponseBody
public java.lang.Boolean setTaskAssignee(@RequestParam(value="ticket",required=false)
                                                                                                                                 java.lang.String paramTicket,
                                                                                                                                 @CookieValue(value="ticket",required=false)
                                                                                                                                 java.lang.String cookieTicket,
                                                                                                                                 @RequestParam
                                                                                                                                 java.lang.String taskId,
                                                                                                                                 @RequestParam
                                                                                                                                 java.lang.String userLoginName)

setTaskStatus

@RequestMapping(value="/settaskstatus",
                method=POST)
 @ResponseBody
public java.lang.Boolean setTaskStatus(@RequestParam(value="ticket",required=false)
                                                                                                                              java.lang.String paramTicket,
                                                                                                                              @CookieValue(value="ticket",required=false)
                                                                                                                              java.lang.String cookieTicket,
                                                                                                                              @RequestParam
                                                                                                                              java.lang.String taskId,
                                                                                                                              @RequestParam
                                                                                                                              java.lang.String status)

getTask

@RequestMapping(value="/gettask",
                method=GET)
 @ResponseBody
public TaskInstance getTask(@RequestParam(value="ticket",required=false)
                                                                                                            java.lang.String paramTicket,
                                                                                                            @CookieValue(value="ticket",required=false)
                                                                                                            java.lang.String cookieTicket,
                                                                                                            @RequestParam
                                                                                                            java.lang.String taskId)

getTasks

@RequestMapping(value="/gettasks",
                method=GET)
 @ResponseBody
public TaskInstance[] getTasks(@RequestParam(value="ticket",required=false)
                                                                                                                java.lang.String paramTicket,
                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                java.lang.String cookieTicket,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String userLoginName,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String workflowInstanceId,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String taskName)

getStartFormKey

@RequestMapping(value="/startform",
                method=GET)
 @ResponseBody
public java.util.Map<java.lang.String,java.lang.Object> getStartFormKey(@RequestParam(value="ticket",required=false)
                                                                                                                                                          java.lang.String paramTicket,
                                                                                                                                                          @CookieValue(value="ticket",required=false)
                                                                                                                                                          java.lang.String cookieTicket,
                                                                                                                                                          @RequestParam(required=true)
                                                                                                                                                          java.lang.String processDefinitionId)

getWorkflowDefinitionTasks

@RequestMapping(value="/workflowdefinitiontasks",
                method=GET)
 @ResponseBody
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getWorkflowDefinitionTasks(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                                                                                   @RequestParam(required=true)
                                                                                                                                                                                                   java.lang.String processDefinitionId)

getUnclaimedTasks

@RequestMapping(value="/getunclaimedtasks",
                method=GET)
 @ResponseBody
public TaskInstance[] getUnclaimedTasks(@RequestParam(value="ticket",required=false)
                                                                                                                                  java.lang.String paramTicket,
                                                                                                                                  @CookieValue(value="ticket",required=false)
                                                                                                                                  java.lang.String cookieTicket,
                                                                                                                                  @RequestParam(required=false)
                                                                                                                                  java.lang.String userLoginName,
                                                                                                                                  @RequestParam(required=false)
                                                                                                                                  java.lang.String workflowInstanceId,
                                                                                                                                  @RequestParam(required=false)
                                                                                                                                  java.lang.String associatedContentId)

getWorkflowPackage

@RequestMapping(value="/getworkflowpackage",
                method=GET)
 @ResponseBody
public WorkflowPackage getWorkflowPackage(@RequestParam(value="ticket",required=false)
                                                                                                                                     java.lang.String paramTicket,
                                                                                                                                     @CookieValue(value="ticket",required=false)
                                                                                                                                     java.lang.String cookieTicket,
                                                                                                                                     @RequestParam(required=false)
                                                                                                                                     java.lang.String workflowInstanceId,
                                                                                                                                     @RequestParam(required=false)
                                                                                                                                     java.lang.String taskId)

cancelWorkflow

@RequestMapping(value="/cancelworkflow",
                method=POST)
 @ResponseBody
public void cancelWorkflow(@RequestParam(value="ticket",required=false)
                                                                                                                   java.lang.String paramTicket,
                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                   java.lang.String cookieTicket,
                                                                                                                   @RequestParam(required=false)
                                                                                                                   java.lang.String workflowInstanceId,
                                                                                                                   @RequestParam(required=false)
                                                                                                                   java.lang.String deleteReason,
                                                                                                                   @RequestParam(required=false)
                                                                                                                   java.lang.String taskId)

getWorkflowInstance

@RequestMapping(value="/getWorkflowInstance",
                method=GET)
 @ResponseBody
public WorkflowInstance getWorkflowInstance(@RequestParam(value="ticket",required=false)
                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                        java.lang.String cookieTicket,
                                                                                                                                        @RequestParam(required=false)
                                                                                                                                        java.lang.String workflowInstanceId,
                                                                                                                                        @RequestParam(required=false)
                                                                                                                                        java.lang.String taskId)

getWorkflowInstanceInfo

@RequestMapping(value="/getWorkflowInstanceInfo",
                method=GET)
 @ResponseBody
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getWorkflowInstanceInfo(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                java.lang.String cookieTicket,
                                                                                                                                                                                                @RequestParam(required=true)
                                                                                                                                                                                                java.lang.String objectId)

getTasksForUserByContent

@RequestMapping(value="/getTasksForUserByContent",
                method=GET)
 @ResponseBody
public TaskInstance[] getTasksForUserByContent(@RequestParam(value="ticket",required=false)
                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                java.lang.String cookieTicket,
                                                                                                                                                @RequestParam(required=true)
                                                                                                                                                java.lang.String objectId,
                                                                                                                                                @RequestParam(required=true)
                                                                                                                                                java.lang.String userLoginName)

getTasksByContent

@RequestMapping(value="/getTasksByContent",
                method=GET)
 @ResponseBody
public java.util.List<java.lang.String> getTasksByContent(@RequestParam(value="ticket",required=false)
                                                                                                                                                    java.lang.String paramTicket,
                                                                                                                                                    @CookieValue(value="ticket",required=false)
                                                                                                                                                    java.lang.String cookieTicket,
                                                                                                                                                    @RequestParam(required=true)
                                                                                                                                                    java.lang.String objectId)

getWorkflowInstanceSnapshot

@RequestMapping(value="/getWorkflowInstanceSnapshot",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowInstanceSnapshot> getWorkflowInstanceSnapshot(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                java.lang.String userLoginName,
                                                                                                                                                                                @RequestParam(value="numPerPage",required=true)
                                                                                                                                                                                int numPerPage,
                                                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                                                java.lang.String cookieTicket)

getAllWorkflowInstanceSnapshots

@RequestMapping(value="/getAllWorkflowInstanceSnapshots",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowInstanceSnapshot> getAllWorkflowInstanceSnapshots(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                        java.lang.String paramTicket,
                                                                                                                                                                                        @CookieValue(value="ticket",required=false)
                                                                                                                                                                                        java.lang.String cookieTicket)

getAllWorkflowInstanceSnapshotsByGroup

@RequestMapping(value="/getWorkflowInstanceSnapshotsByGroup",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowInstanceSnapshot> getAllWorkflowInstanceSnapshotsByGroup(@RequestParam(value="ticket",required=false)
                                                                                                                                                                                                   java.lang.String paramTicket,
                                                                                                                                                                                                   @CookieValue(value="ticket",required=false)
                                                                                                                                                                                                   java.lang.String cookieTicket,
                                                                                                                                                                                                   @RequestParam(value="groups",required=true)
                                                                                                                                                                                                   java.lang.String groups)

getAllWorkflowInstances

@RequestMapping(value="getAllWorkflowInstances",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowInstance> getAllWorkflowInstances(@RequestParam(value="ticket",required=false)
                                                                                                                                                               java.lang.String paramTicket,
                                                                                                                                                               @CookieValue(value="ticket",required=false)
                                                                                                                                                               java.lang.String cookieTicket)

See Also:

IWorkflow.getAllWorkflowInstances(String)

getOrphanedWorkflows

@RequestMapping(value="getOrphanedWorkflows",
                method=GET)
 @ResponseBody
public java.util.List<WorkflowInstance> getOrphanedWorkflows(@RequestParam(value="ticket",required=false)
                                                                                                                                                         java.lang.String paramTicket,
                                                                                                                                                         @CookieValue(value="ticket",required=false)
                                                                                                                                                         java.lang.String cookieTicket)

See Also:

IWorkflow.getOrphanedWorkflows(String)

abortOrphanedWorkflows

@RequestMapping(value="abortOrphanedWorkflows",
                method=DELETE)
 @ResponseBody
public java.util.List<WorkflowInstance> abortOrphanedWorkflows(@RequestParam(value="ticket",required=false)
                                                                                                                                                                java.lang.String paramTicket,
                                                                                                                                                                @CookieValue(value="ticket",required=false)
                                                                                                                                                                java.lang.String cookieTicket)

See Also:

IWorkflow.abortOrphanedWorkflows(String)