com.atlassian.servicedesk.api.portal

Interface PortalService

@PublicApi
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public interface PortalService

Provides access to Portal objects.

Method Summary

Modifier and Type	Method and Description
Portal	getPortalForId(com.atlassian.jira.user.ApplicationUser user, int portalId) Returns the Portal associated with the given portal id.
Portal	getPortalForProject(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.project.Project project) Returns the Portal associated with the given Project.
Portal	getPortalForServiceDesk(com.atlassian.jira.user.ApplicationUser user, ServiceDesk serviceDesk) Returns the Portal associated with the given ServiceDesk.
PagedResponse<Portal>	getPortals(com.atlassian.jira.user.ApplicationUser user, PagedRequest pagedRequest) Return a PagedResponse of all of the portals

Method Detail

getPortals

PagedResponse<Portal> getPortals(com.atlassian.jira.user.ApplicationUser user,
                                 PagedRequest pagedRequest)

Return a PagedResponse of all of the portals

Parameters:

user - the user requesting the portals

pagedRequest - the paging to be applied to the output

Returns:

PagedResponse for the portals

Throws:

ServiceDeskServiceException - on error

getPortalForProject

Portal getPortalForProject(com.atlassian.jira.user.ApplicationUser user,
                           com.atlassian.jira.project.Project project)

Returns the Portal associated with the given Project.

Parameters:

user - the user requesting the portal

project - the project to search by

Returns:

Portal associated with the given Project

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found

AuthorizationException - if user does not have permission to access portal

getPortalForId

Portal getPortalForId(com.atlassian.jira.user.ApplicationUser user,
                      int portalId)

Returns the Portal associated with the given portal id.

Parameters:

user - the user requesting the portal

portalId - the id of the portal

Returns:

Portal associated with the given portal id

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found

AuthorizationException - if user does not have permission to access portal

getPortalForServiceDesk

Portal getPortalForServiceDesk(com.atlassian.jira.user.ApplicationUser user,
                               ServiceDesk serviceDesk)

Returns the Portal associated with the given ServiceDesk.

Parameters:

user - the user requesting the portal

serviceDesk - the service project to search by

Returns:

Portal associated with the given ServiceDesk

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found

AuthorizationException - if user does not have permission to access portal

Since:

v3.7.0