com.atlassian.servicedesk.api

Interface ServiceDeskManager

@PublicApi
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public interface ServiceDeskManager

Provides access to ServiceDesk objects without permission checks. It is intended this should only be required when performing administrative tasks where you need access regardless of permissions or without a user. Usually the ServiceDeskService should be preferred.

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskById(int serviceDeskId) Retrieve a ServiceDesk by its ID
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskForPortal(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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk>	getServiceDeskForProject(com.atlassian.jira.project.Project project) Returns an Either with the ServiceDesk associated with the given Project or AnError if: - Service Desk was not found - Service Desk was disabled

Method Detail

getServiceDeskForProject

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

Returns an Either with the ServiceDesk associated with the given Project or AnError if: - Service Desk was not found - Service Desk was disabled

Parameters:

project - the project to search by.

Returns:

An Either containing ServiceDesk associated with the given {

getServiceDeskById

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

Retrieve a ServiceDesk by its ID

Parameters:

serviceDeskId - the service desk ID

Returns:

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

Since:

v3.7.0

getServiceDeskForPortal

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,ServiceDesk> getServiceDeskForPortal(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

Parameters:

portal - the portal to search by.

Returns:

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

Since:

v3.7.0