com.atlassian.servicedesk.api

Interface ServiceDeskService

@PublicApi
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public interface ServiceDeskService

Provides access to ServiceDesk objects

Method Summary

Modifier and Type	Method and Description
ServiceDesk	getServiceDeskById(com.atlassian.jira.user.ApplicationUser user, int serviceDeskId) Retrieve a ServiceDesk by its ID
ServiceDesk	getServiceDeskForPortal(com.atlassian.jira.user.ApplicationUser user, Portal portal) Returns the ServiceDesk associated with the given Portal
ServiceDesk	getServiceDeskForProject(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.project.Project project) Returns the ServiceDesk associated with the given Project
PagedResponse<ServiceDesk>	getServiceDesks(com.atlassian.jira.user.ApplicationUser user, boolean includeArchived, PagedRequest pagedRequest) Returns a list of service projects a user can view, with an option to include archived service projects.
default PagedResponse<ServiceDesk>	getServiceDesks(com.atlassian.jira.user.ApplicationUser user, PagedRequest pagedRequest) Returns a list of service projects a user can view.

Method Detail

getServiceDeskForProject

ServiceDesk getServiceDeskForProject(com.atlassian.jira.user.ApplicationUser user,
                                     com.atlassian.jira.project.Project project)

Returns the ServiceDesk associated with the given Project

Parameters:

user - the user requesting the service project

project - the project to search by

Returns:

ServiceDesk associated with the given Project

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - on error if a service project was disabled or not found

getServiceDeskById

ServiceDesk getServiceDeskById(com.atlassian.jira.user.ApplicationUser user,
                               int serviceDeskId)

Retrieve a ServiceDesk by its ID

Parameters:

user - the user executing the request

serviceDeskId - the service project ID

Returns:

the requested ServiceDesk

Throws:

ServiceDeskServiceException - on error

getServiceDesks

default PagedResponse<ServiceDesk> getServiceDesks(com.atlassian.jira.user.ApplicationUser user,
                                                   PagedRequest pagedRequest)

Returns a list of service projects a user can view. This does not include archived service projects.

Parameters:

user - the user executing the request

pagedRequest - the paging to be applied to the output

Returns:

a paged response of ServiceDesk

Throws:

ServiceDeskServiceException - on error

getServiceDesks

PagedResponse<ServiceDesk> getServiceDesks(com.atlassian.jira.user.ApplicationUser user,
                                           boolean includeArchived,
                                           PagedRequest pagedRequest)

Returns a list of service projects a user can view, with an option to include archived service projects.

Parameters:

user - the user executing the request

includeArchived - determines whether archived service projects are included; this is false by default

pagedRequest - the paging to be applied to the output

Returns:

a paged response of ServiceDesk

Throws:

ServiceDeskServiceException - on error

getServiceDeskForPortal

ServiceDesk getServiceDeskForPortal(com.atlassian.jira.user.ApplicationUser user,
                                    Portal portal)

Returns the ServiceDesk associated with the given Portal

Parameters:

user - the user requesting the service project

portal - the portal to search by

Returns:

ServiceDesk associated with the given Portal

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - on error if a service project was disabled or not found

Since:

v3.7.0