@PublicApi @ParametersAreNonnullByDefault @ReturnValuesAreNonnullByDefault public interface ServiceDeskService
ServiceDesk
objectsModifier 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 desks a user can view, with an option to include archived service desks.
|
default PagedResponse<ServiceDesk> |
getServiceDesks(com.atlassian.jira.user.ApplicationUser user,
PagedRequest pagedRequest)
Returns a list of service desks a user can view.
|
ServiceDesk getServiceDeskForProject(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.project.Project project)
ServiceDesk
associated with the given Project
user
- the user requesting the service deskproject
- the project to search byServiceDesk
associated with the given Project
ServiceDeskServiceException
- on errorNoSuchEntityException
- on error if service desk was not found or disabledServiceDesk getServiceDeskById(com.atlassian.jira.user.ApplicationUser user, int serviceDeskId)
ServiceDesk
by its IDuser
- the user executing the requestserviceDeskId
- the service desk IDServiceDesk
ServiceDeskServiceException
- on errordefault PagedResponse<ServiceDesk> getServiceDesks(com.atlassian.jira.user.ApplicationUser user, PagedRequest pagedRequest)
user
- the user executing the requestpagedRequest
- the paging to be applied to the outputServiceDesk
ServiceDeskServiceException
- on errorPagedResponse<ServiceDesk> getServiceDesks(com.atlassian.jira.user.ApplicationUser user, boolean includeArchived, PagedRequest pagedRequest)
user
- the user executing the requestincludeArchived
- determines whether archived service desks are included; this is false by defaultpagedRequest
- the paging to be applied to the outputServiceDesk
ServiceDeskServiceException
- on errorServiceDesk getServiceDeskForPortal(com.atlassian.jira.user.ApplicationUser user, Portal portal)
ServiceDesk
associated with the given Portal
user
- the user requesting the service deskportal
- the portal to search byServiceDesk
associated with the given Portal
ServiceDeskServiceException
- on errorNoSuchEntityException
- on error if service desk was not found or disabledCopyright © 2020 Atlassian. All rights reserved.