com.atlassian.servicedesk.api.portal

Interface PortalManager

@PublicApi
 @ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public interface PortalManager

Provides access to Portal 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 PortalService should be preferred.

Since:

v3.7.0

Method Summary

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

Method Detail

getPortals

PagedResponse<Portal> getPortals(PagedRequest pagedRequest)

Return a PagedResponse of all of the portals

Parameters:

pagedRequest - the paging to be applied to the output

Returns:

PagedResponse for the portals

Throws:

ServiceDeskServiceException - on error

getPortalForProject

Portal getPortalForProject(com.atlassian.jira.project.Project project)

Returns Portal associated with the given Project.

Parameters:

project - the project to search by.

Returns:

Portal associated with the given Project

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found

getPortalForId

Portal getPortalForId(int portalId)

Returns the Portal associated with the given portal id.

Parameters:

portalId - the id of the portal.

Returns:

Portal associated with the given portal id

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found

getPortalForServiceDesk

Portal getPortalForServiceDesk(ServiceDesk serviceDesk)

Returns the Portal associated with the given ServiceDesk.

Parameters:

serviceDesk - the service project to search by.

Returns:

Portal associated with the given ServiceDesk

Throws:

ServiceDeskServiceException - on error

NoSuchEntityException - if portal is not found