Package com.atlassian.servicedesk.api.queue

Interface QueueService

@PublicApi public interface QueueService
Provide access to Queue objects and their issues

  • Method Details

    • newQueueQueryBuilder

      QueueQuery.Builder newQueueQueryBuilder()
      Returns:
      a new QueueQuery.Builder instance to construct QueueQuery

    • getQueues

      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
      Throws:
      ServiceDeskServiceException - on error

    • newQueueRequestQueryBuilder

      QueueRequestQuery.Builder newQueueRequestQueryBuilder()
      Returns:
      a new QueueRequestQuery.Builder instance to construct QueueRequestQuery

    • getRequestsByQueue

      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
      Throws:
      ServiceDeskServiceException - on error

    • getQueueLimitForProject

      int getQueueLimitForProject()
      Gets the maximum number of queues allowed for a project
      Returns:
      queuesLimit limit of queues for a project

    • newQueueCreateParameterBuilder

      QueueCreateParameters.Builder newQueueCreateParameterBuilder(int serviceDeskId, @Nonnull String queueName)
      Get a new QueueCreateParameters builder.
      Parameters:
      serviceDeskId - The id of a service project for the queue
      queueName - The name of the queue
      Returns:
      A new QueueCreateParameters.Builder instance to construct QueueCreateParameters

    • newQueueUpdateParameterBuilder

      QueueUpdateParameters.Builder newQueueUpdateParameterBuilder(int serviceDeskId, int queueId)
      Get a new QueueUpdateParameters builder.
      Parameters:
      serviceDeskId - The service project for the queue
      queueId - The id of the queue to update
      Returns:
      A new QueueUpdateParameters.Builder instance to construct QueueUpdateParameters

    • addQueue

      Queue addQueue(@Nonnull com.atlassian.jira.user.ApplicationUser user, @Nonnull QueueCreateParameters queueCreateParameters)
      Given the required QueueParameters create a new Queue in the service project
      Parameters:
      user - the user executing the request
      queueCreateParameters - the create parameters
      Returns:
      The newly created Queue
      Throws:
      ServiceDeskServiceException - on error

    • updateQueue

      Queue updateQueue(@Nonnull com.atlassian.jira.user.ApplicationUser user, @Nonnull QueueUpdateParameters queueUpdateParameters)
      Given the required QueueParameters update the Queue in the service project. All fields present in the update parameters will override existing values and if a field is not present it will be ignored.
      Parameters:
      user - the user executing the request
      queueUpdateParameters - the new queue parameters
      Returns:
      The updated queue Queue
      Throws:
      ServiceDeskServiceException - on error

    • deleteQueue

      void deleteQueue(@Nonnull com.atlassian.jira.user.ApplicationUser user, int serviceDeskId, int queueId)
      Delete Queue for the given id
      Parameters:
      user - the user executing the request
      serviceDeskId - the id of a service project
      queueId - the id of the Queue to delete
      Throws:
      ServiceDeskServiceException - on error

    • reorderQueues

      List<Queue> reorderQueues(@Nonnull com.atlassian.jira.user.ApplicationUser user, int serviceDeskId, @Nonnull List<Integer> newQueueOrderId)
      Reorder the list of Queue for a given service project
      Parameters:
      user - the user executing the request
      serviceDeskId - the id of a service project
      newQueueOrderId - the new order of Queue id's
      Returns:
      List of all Queue's in the new order
      Throws:
      ServiceDeskServiceException - on error