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

Method Detail

getPortalForProject

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

Returns an Either with the Portal associated with the given Project or AnError if: - Portal was not found - The user is does not have permission to access portal

Parameters:

user - the user requesting the portal

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(com.atlassian.jira.user.ApplicationUser user,
                                                                                                      int portalId)

Returns an Either with the Portal associated with the given portal id or AnError if: - Portal was not found - The user is does not have permission to access portal

Parameters:

user - the user requesting the portal

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(com.atlassian.jira.user.ApplicationUser user,
                                                                                                               ServiceDesk serviceDesk)

Returns an Either with the Portal associated with the given ServiceDesk or AnError if: - Portal was not found - The user is does not have permission to access portal

Parameters:

user - the user requesting the portal

serviceDesk - the service desk to search by.

Returns:

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

Since:

v3.7.0