com.atlassian.servicedesk.api.portal

Interface PortalManager

@ExperimentalApi
 @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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal>	getPortalForId(int portalId) Returns an Either with the Portal associated with the given portal id or AnError if: - Portal was not found
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal>	getPortalForProject(com.atlassian.jira.project.Project project) Returns an Either with the Portal associated with the given Project or AnError if: - Portal was not found
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal>	getPortalForServiceDesk(ServiceDesk serviceDesk) Returns an Either with the Portal associated with the given ServiceDesk or AnError if: - Portal was not found

Method Detail

getPortalForProject

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

Returns an Either with the Portal associated with the given Project or AnError if: - Portal was not found

Parameters:

project - the project to search by.

Returns:

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

getPortalForId

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal> getPortalForId(int portalId)

Returns an Either with the Portal associated with the given portal id or AnError if: - Portal was not found

Parameters:

portalId - the id of the portal.

Returns:

An Either containing Portal associated with the given portal id or AnError.

getPortalForServiceDesk

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal> getPortalForServiceDesk(ServiceDesk serviceDesk)

Returns an Either with the Portal associated with the given ServiceDesk or AnError if: - Portal was not found

Parameters:

serviceDesk - the service desk to search by.

Returns:

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