|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowService
Provides workflow related service methods
Field Summary | |
---|---|
static java.lang.String |
SERVICE
|
Method Summary | |
---|---|
ServiceOutcome<java.lang.Void> |
addStatusToGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user,
com.atlassian.jira.workflow.JiraWorkflow workflow,
com.atlassian.jira.issue.status.Status status)
Modifies the GreenHopper Simplified Workflow to include the specified Status as a step with its associated
global transitions. |
ServiceOutcome<com.atlassian.jira.issue.status.Status> |
canStatusBeRemovedFromGreenHopperSimplifiedWorkflow(com.atlassian.jira.workflow.JiraWorkflow workflow,
java.lang.String statusId)
Checks to see if the specified status can be removed from the specified JiraWorkflow . |
ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> |
convertTransitionsToSimplified(com.atlassian.crowd.embedded.api.User user,
com.atlassian.jira.workflow.JiraWorkflow workflow)
Converts a workflow so that it will have only global transitions to all steps. |
ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> |
copyWorkflow(com.atlassian.crowd.embedded.api.User user,
com.atlassian.jira.workflow.JiraWorkflow workflow,
java.lang.String newName,
java.lang.String newDescription)
Creates a new copy of the existing workflow, with the specified name and description. |
ServiceOutcome<java.lang.Void> |
deleteScheme(java.lang.String name)
Delete a workflow scheme with the specified name |
ServiceOutcome<java.lang.Void> |
deleteWorkflow(java.lang.String name)
Delete a workflow with the specified name. |
ServiceOutcome<java.lang.Boolean> |
doesWorkflowSchemeExist(java.lang.String name)
Does a workflow scheme with the specified name exist? |
java.util.Set<com.atlassian.jira.issue.status.Status> |
getAccessibleStatuses(com.atlassian.crowd.embedded.api.User user,
com.atlassian.query.Query query)
Get the list of accessible statuses for issues potentially returned by the current query. |
java.util.Set<com.atlassian.jira.issue.status.Status> |
getAllWorkflowStatusObjects()
Get all workflow statuses available in the system |
ServiceOutcome<com.atlassian.jira.util.lang.Pair<com.atlassian.jira.workflow.JiraWorkflow,com.atlassian.jira.project.Project>> |
getGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user,
com.atlassian.query.Query query)
Attempts to retrieve the GreenHopper Simplified Workflow that is backing the Query . |
ServiceOutcome<com.atlassian.jira.util.lang.Pair<com.atlassian.jira.workflow.JiraWorkflow,com.atlassian.jira.project.Project>> |
getPotentialWorkflowForConversion(com.atlassian.crowd.embedded.api.User user,
com.atlassian.query.Query query)
Attempts to retrieve a potential GreenHopper Simplified Workflow that is backing the Query . |
com.atlassian.jira.issue.status.Status |
getStatusByName(java.lang.String statusName)
Get a status given its name |
ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> |
getWorkflow(com.atlassian.crowd.embedded.api.User user,
java.lang.String workflowName)
Retrieve the workflow with the specified name |
ServiceOutcome<com.atlassian.jira.scheme.Scheme> |
getWorkflowSchemeForProject(com.atlassian.jira.project.Project project)
Returns the scheme currently associated to the specified Project . |
ServiceOutcome<java.util.Collection<com.atlassian.jira.workflow.JiraWorkflow>> |
getWorkflowsForProject(com.atlassian.jira.project.Project project)
Retrieve the workflows that are in use for the specified Project . |
com.atlassian.jira.issue.status.Status |
getWorkflowStatusObject(java.lang.String statusId)
Get the status object for a given id |
ServiceOutcome<java.lang.Boolean> |
isStatusInitialStatus(com.atlassian.jira.workflow.JiraWorkflow workflow,
com.atlassian.jira.issue.status.Status status)
Is this status the initial status for this workflow? |
ServiceOutcome<java.lang.Boolean> |
isWorkflowSchemeActive(java.lang.String name)
Is the workflow scheme with the specified name active? |
ServiceOutcome<java.lang.Void> |
removeStatusFromGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user,
com.atlassian.jira.workflow.JiraWorkflow workflow,
com.atlassian.jira.issue.status.Status status)
Removes the specified Status associated step and global transition from the GreenHopper Simplified Workflow. |
ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> |
replaceInitialStatusInGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user,
com.atlassian.jira.workflow.JiraWorkflow workflow,
com.atlassian.jira.issue.status.Status oldInitialStatus,
com.atlassian.jira.issue.status.Status newInitialStatus)
Replaces the initial status specified in the workflow with a new one. |
Field Detail |
---|
static final java.lang.String SERVICE
Method Detail |
---|
java.util.Set<com.atlassian.jira.issue.status.Status> getAllWorkflowStatusObjects()
com.atlassian.jira.issue.status.Status getWorkflowStatusObject(java.lang.String statusId)
statusId
- the id to look up
com.atlassian.jira.issue.status.Status getStatusByName(java.lang.String statusName)
@NotNull java.util.Set<com.atlassian.jira.issue.status.Status> getAccessibleStatuses(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query)
user
- the user who would be performing the searchquery
- the query being asked about
@NotNull ServiceOutcome<com.atlassian.jira.util.lang.Pair<com.atlassian.jira.workflow.JiraWorkflow,com.atlassian.jira.project.Project>> getGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query)
Query
. This will fail if
the query does not meet the criteria for a Simplified Workflow.
The criteria is as follows:
user
- the user trying to retrieve the workflowquery
- the query to look at
@NotNull ServiceOutcome<com.atlassian.jira.util.lang.Pair<com.atlassian.jira.workflow.JiraWorkflow,com.atlassian.jira.project.Project>> getPotentialWorkflowForConversion(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.query.Query query)
Query
. It
is necessary that a Simplified Workflow is a potential Simplified Workflow, but not the other way around.
This will just determine if the user may be allowed to kick off a conversion.
The criteria here is less stringent:
user
- the user retrieving the workflowquery
- the query to look at
@NotNull ServiceOutcome<com.atlassian.jira.issue.status.Status> canStatusBeRemovedFromGreenHopperSimplifiedWorkflow(@NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull java.lang.String statusId)
JiraWorkflow
. It assumes that
the workflow is a GreenHopper Simplified Workflow.
The status can only be removed if:
workflow
- the workflowstatusId
- the ID of the status to look for
@NotNull ServiceOutcome<java.lang.Void> removeStatusFromGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull com.atlassian.jira.issue.status.Status status)
Status
associated step and global transition from the GreenHopper Simplified Workflow.
Assumes that the workflow is a GreenHopper Simplified Workflow.
If the status is no longer in use by any workflow, it will be removed from the system entirely.
user
- the userworkflow
- the workflowstatus
- the status to remove
@NotNull ServiceOutcome<java.lang.Boolean> isStatusInitialStatus(@NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull com.atlassian.jira.issue.status.Status status)
workflow
- the workflowstatus
- the status
@NotNull ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> replaceInitialStatusInGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull com.atlassian.jira.issue.status.Status oldInitialStatus, @NotNull com.atlassian.jira.issue.status.Status newInitialStatus)
user
- the userworkflow
- the workflowoldInitialStatus
- the status to removenewInitialStatus
- the status to replace it with
@NotNull ServiceOutcome<java.lang.Void> addStatusToGreenHopperSimplifiedWorkflow(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull com.atlassian.jira.issue.status.Status status)
Status
as a step with its associated
global transitions.
If the status already exists in the specified workflow, nothing will be changed.
user
- the userworkflow
- the workflow to modify - must be a GreenHopper Simplified Workflowstatus
- the status
@NotNull ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> copyWorkflow(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.jira.workflow.JiraWorkflow workflow, @NotNull java.lang.String newName, @NotNull java.lang.String newDescription)
user
- the userworkflow
- the original workflownewName
- the new namenewDescription
- the new description
@NotNull ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> convertTransitionsToSimplified(com.atlassian.crowd.embedded.api.User user, @NotNull com.atlassian.jira.workflow.JiraWorkflow workflow)
user
- the userworkflow
- the original workflow
@NotNull ServiceOutcome<com.atlassian.jira.workflow.JiraWorkflow> getWorkflow(com.atlassian.crowd.embedded.api.User user, @NotNull java.lang.String workflowName)
user
- the userworkflowName
- the workflow name
@NotNull ServiceOutcome<java.util.Collection<com.atlassian.jira.workflow.JiraWorkflow>> getWorkflowsForProject(com.atlassian.jira.project.Project project)
Project
.
project
- the project
@NotNull ServiceOutcome<java.lang.Boolean> doesWorkflowSchemeExist(java.lang.String name)
name
- the name
@NotNull ServiceOutcome<com.atlassian.jira.scheme.Scheme> getWorkflowSchemeForProject(com.atlassian.jira.project.Project project)
Project
. null
will be the result
if there is no scheme associated (i.e. the Default Scheme is in use).
project
- the project
@NotNull ServiceOutcome<java.lang.Boolean> isWorkflowSchemeActive(java.lang.String name)
name
- the name
@NotNull ServiceOutcome<java.lang.Void> deleteScheme(java.lang.String name)
name
- workflow scheme name
@NotNull ServiceOutcome<java.lang.Void> deleteWorkflow(java.lang.String name)
name
- workflow name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |