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 TypeMethodDescriptiongetPortalForId(int portalId) Returns thePortalassociated with the given portal id.getPortalForProject(com.atlassian.jira.project.Project project) ReturnsPortalassociated with the givenProject.getPortalForServiceDesk(ServiceDesk serviceDesk) Returns thePortalassociated with the givenServiceDesk.getPortals(PagedRequest pagedRequest) Return aPagedResponseof all of the portals
-
Method Details
-
getPortals
Return aPagedResponseof all of the portals- Parameters:
pagedRequest- the paging to be applied to the output- Returns:
PagedResponsefor the portals- Throws:
ServiceDeskServiceException- on error
-
getPortalForProject
ReturnsPortalassociated with the givenProject.- Parameters:
project- the project to search by.- Returns:
Portalassociated with the givenProject- Throws:
ServiceDeskServiceException- on errorNoSuchEntityException- if portal is not found
-
getPortalForId
Returns thePortalassociated with the given portal id.- Parameters:
portalId- the id of the portal.- Returns:
Portalassociated with the given portal id- Throws:
ServiceDeskServiceException- on errorNoSuchEntityException- if portal is not found
-
getPortalForServiceDesk
Returns thePortalassociated with the givenServiceDesk.- Parameters:
serviceDesk- the service project to search by.- Returns:
Portalassociated with the givenServiceDesk- Throws:
ServiceDeskServiceException- on errorNoSuchEntityException- if portal is not found
-