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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskById(com.atlassian.jira.user.ApplicationUser user, int serviceDeskId) Retrieve a ServiceDesk by its ID
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskForPortal(com.atlassian.jira.user.ApplicationUser user, Portal portal) Returns an Either of the ServiceDesk associated with the given Portal or AnError if: - Service Desk was not found - Service Desk was disabled - User does not have access to the ServiceDesk
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskForProject(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.project.Project project) Returns an Either of the ServiceDesk associated with the given Project or AnError if: - Service Desk was not found - Service Desk was disabled - User does not have access to the ServiceDesk
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<ServiceDesk>>	getServiceDesks(com.atlassian.jira.user.ApplicationUser user, PagedRequest pagedRequest) Returns a page of service desks a user can see.

Method Detail

getServiceDeskForProject

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk> getServiceDeskForProject(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                     com.atlassian.jira.project.Project project)

Returns an Either of the ServiceDesk associated with the given Project or AnError if: - Service Desk was not found - Service Desk was disabled - User does not have access to the ServiceDesk

Parameters:

user - the user requesting the service desk.

project - the project to search by.

Returns:

An Either containing ServiceDesk associated with the given Project or AnError.

getServiceDeskById

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk> getServiceDeskById(com.atlassian.jira.user.ApplicationUser user,
                                                                                                               int serviceDeskId)

Retrieve a ServiceDesk by its ID

Parameters:

user - the user excuting the request

serviceDeskId - the service desk ID

Returns:

an Either of an AnError if retrieval error, or the requested ServiceDesk

getServiceDesks

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<ServiceDesk>> getServiceDesks(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                           PagedRequest pagedRequest)

Returns a page of service desks a user can see.

Parameters:

user - the user executing the request

pagedRequest - the paging to be applied to the output

Returns:

the paged response or an error

getServiceDeskForPortal

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk> getServiceDeskForPortal(com.atlassian.jira.user.ApplicationUser user,
                                                                                                                    Portal portal)

Returns an Either of the ServiceDesk associated with the given Portal or AnError if: - Service Desk was not found - Service Desk was disabled - User does not have access to the ServiceDesk

Parameters:

user - the user requesting the service desk.

portal - the portal to search by.

Returns:

An Either containing ServiceDesk associated with the given Portal or AnError.

Since:

v3.7.0