public interface TaskService
StateService
Modifier and Type | Method and Description |
---|---|
Task |
assignTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String assignee,
String comment)
Deprecated.
|
Task |
assignTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String assignee,
String comment,
Date dueDate)
Assigns the given task
|
Task |
completeTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String outcome,
String comment)
Completes the given task.
|
Task |
createTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskName,
String assignee,
String comment)
Create a task on the content in the current State.
|
Task |
createTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskName,
String assignee,
String comment,
Date dueDate)
Create a task on the content in the current State.
|
Task |
editTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String newTaskName)
Deprecated.
since 1.3, use
editTask(ContentEntityObject, String, String, String, Date) |
Task |
editTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String newTaskName,
String newComment,
Date dueDate)
Edits a currently existing task
|
List<ContentTask> |
getActiveTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
Returns a list of tasks which are currently active on the given content
object.
|
List<ContentTask> |
getAssigned(String userName,
Set<String> spaceKeys)
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API. You can found the list of available CQL mappings for Comala Workflows in our documentation wiki. |
List<ContentTask> |
getAvailable(Set<String> spaceKeys)
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API. You can found the list of available CQL mappings for Comala Workflows in our documentation wiki. |
List<ContentTask> |
getCompletedTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
Returns a list of tasks which are completed on the given content object.
|
List<ContentTask> |
getTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
Returns all tasks which are on the given content object.
|
void |
removeTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId)
Removes a given task
|
void |
removeTask(com.atlassian.confluence.core.ContentEntityObject content,
String taskId,
String comment)
Removes a given task
|
Task createTask(com.atlassian.confluence.core.ContentEntityObject content, String taskName, String assignee, String comment, Date dueDate) throws WorkflowException
content
- the content objecttaskName
- the name of the taskassignee
- the name of the assignee (optional)comment
- a comment of description of the taskdueDate
- the due date for this task. (alpha functionality, not yet supported)WorkflowException
Task createTask(com.atlassian.confluence.core.ContentEntityObject content, String taskName, String assignee, String comment) throws WorkflowException
content
- the content objecttaskName
- the name of the taskassignee
- the name of the assignee (optional)comment
- a comment of description of the taskWorkflowException
Task editTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String newTaskName) throws WorkflowException
editTask(ContentEntityObject, String, String, String, Date)
content
- the content objecttaskId
- the id of the task to editnewTaskName
- the new name of the taskWorkflowException
Task editTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String newTaskName, String newComment, Date dueDate) throws WorkflowException
content
- the content objecttaskId
- the id of the task to editnewTaskName
- the new name of the tasknewComment
- the new comment for the taskdueDate
- the new due date for the task (alpha functionality, not yet supported)WorkflowException
Task completeTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String outcome, String comment) throws WorkflowException
content
- the content objecttaskId
- the id of the task to completeoutcome
- the outcome of the task. User approved or rejected for Approval-type taskscomment
- a comment associated with the completionWorkflowException
void removeTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId) throws WorkflowException
content
- the content objecttaskId
- the id of the task to removeWorkflowException
void removeTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String comment) throws WorkflowException
content
- the content objecttaskId
- the id of the task to removecomment
- the comment associated with the deletionWorkflowException
Task assignTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String assignee, String comment) throws WorkflowException
assignTask(ContentEntityObject, String, String, String, Date)
content
- the content objecttaskId
- the id of the task (in the current state)assignee
- the name of the assigneecomment
- the comment associated to this assignmentWorkflowException
Task assignTask(com.atlassian.confluence.core.ContentEntityObject content, String taskId, String assignee, String comment, Date dueDate) throws WorkflowException
content
- the content objecttaskId
- the id of the task (in the current state)assignee
- the name of the assigneecomment
- the comment associated to this assignmentdueDate
- the due date for this task. (alpha functionality, not yet supported)WorkflowException
List<ContentTask> getAvailable(Set<String> spaceKeys)
spaceKeys
- optional set of space keys to filter with. (Empty set
signifies all spaces).List<ContentTask> getAssigned(String userName, Set<String> spaceKeys)
userName
- the user name to filterspaceKeys
- optional set of space keys to filter with. (Empty set signifies all spaces).List<ContentTask> getTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
ceo
- the Content object to return the tasks for.List<ContentTask> getActiveTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
ceo
- the content object to return the active tasks for.List<ContentTask> getCompletedTasks(com.atlassian.confluence.core.ContentEntityObject ceo)
ceo
- the content object to returne the completed tasks for.Copyright © 2021 Comala Technology Solutions, Inc.. All rights reserved.