com.atlassian.servicedesk.api.portal

Interface PortalService

@ExperimentalApi
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, long portalId) Returns an Either with the Portal associated with the given portal id or AnError if: - Portal was not found - Service Desk was disabled - 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)

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)

Parameters:

user - the user requesting the portal

project - the project to search by.

Returns:

An Either containing Portal associated with the given {

getPortalForId

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,Portal> getPortalForId(com.atlassian.jira.user.ApplicationUser user,
                                                                                                      long portalId)

Returns an Either with the Portal associated with the given portal id or AnError if: - Portal was not found - Service Desk was disabled - 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.