com.atlassian.greenhopper.service.workflow
Interface WorkflowService

All Known Implementing Classes:

WorkflowServiceImpl

public interface WorkflowService

Provides workflow related service methods

Field Summary

static java.lang.String

SERVICE

Method Summary

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
com.atlassian.jira.issue.status.Status	getStatusByName(java.lang.String statusName) Get a status given its name
com.atlassian.jira.issue.status.Status	getWorkflowStatusObject(java.lang.String statusId) Get the status object for a given id

Field Detail

SERVICE

static final java.lang.String SERVICE

See Also:

Constant Field Values

Method Detail

getAllWorkflowStatusObjects

java.util.Set<com.atlassian.jira.issue.status.Status> getAllWorkflowStatusObjects()

Get all workflow statuses available in the system

getWorkflowStatusObject

com.atlassian.jira.issue.status.Status getWorkflowStatusObject(java.lang.String statusId)

Get the status object for a given id

Parameters:

statusId - the id to look up

Returns:

a status object or null if the id is invalid

getStatusByName

com.atlassian.jira.issue.status.Status getStatusByName(java.lang.String statusName)

Get a status given its name

getAccessibleStatuses

@NotNull
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. In effect we are asking, "What projects and issue types could be returned by this query for this user, and what statuses are linked to workflows assigned to those projects and issue types?".

Parameters:

user - the user who would be performing the search

query - the query being asked about

Returns:

the list of statuses