com.atlassian.servicedesk.api.queue

Interface QueueService

@PublicApi
public interface QueueService

Provide access to Queue objects and their issues

Method Summary

Modifier and Type	Method and Description
int	getQueueLimitForProject() Gets the maximum number of queues allowed for a project
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<Queue>>	getQueues(com.atlassian.jira.user.ApplicationUser user, QueueQuery queueQuery) Get a page of Queue that satisfies the provided QueueQuery.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.issue.Issue>>	getRequestsByQueue(com.atlassian.jira.user.ApplicationUser user, QueueRequestQuery query) Get a page of Issue belonging to the specified Queue
QueueQuery.Builder	newQueueQueryBuilder()
QueueRequestQuery.Builder	newQueueRequestQueryBuilder()

Method Detail

newQueueQueryBuilder

QueueQuery.Builder newQueueQueryBuilder()

Returns:

a new QueueQuery.Builder instance to construct QueueQuery

getQueues

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<Queue>> getQueues(com.atlassian.jira.user.ApplicationUser user,
                                                                                                               QueueQuery queueQuery)

Get a page of Queue that satisfies the provided QueueQuery.

Parameters:

user - the user executing the request

queueQuery - the query parameter

Returns:

a page of Queue if success, or AnError if failure

newQueueRequestQueryBuilder

QueueRequestQuery.Builder newQueueRequestQueryBuilder()

Returns:

a new QueueRequestQuery.Builder instance to construct QueueRequestQuery

getRequestsByQueue

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<com.atlassian.jira.issue.Issue>> getRequestsByQueue(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                                 QueueRequestQuery query)

Get a page of Issue belonging to the specified Queue

Parameters:

user - the user executing the request

query - the query parameter

Returns:

a page of Issue if success, or AnError if failure

getQueueLimitForProject

int getQueueLimitForProject()

Gets the maximum number of queues allowed for a project

Returns:

queuesLimit limit of queues for a project