com.atlassian.jira.portal
Interface PortalPage

All Superinterfaces:

Favourite, SharedEntity

All Known Implementing Classes:

AbstractPortalPageImpl, DefaultPortalPageImpl, PortalPageImpl

public interface PortalPage
extends SharedEntity

A PortalPage is a named page of Portlets. It is a SharedEntity.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.SharedEntity

SharedEntity.Indentifier, SharedEntity.SharePermissions, SharedEntity.TypeDescriptor

Field Summary

static SharedEntity.TypeDescriptor

ENTITY_TYPE This is the SharedEntity type, eg "PortalPage"

Method Summary

void	addPortletConfig(PortletConfiguration portletConfiguration) This adds a PortletConfiguration to the PortalPage.
PortalPage	copy() Create a copy of the current portal page.
void	deletePortletConfig(Long portletConfigId) Deletes the PortletConfiguration with the portletConfigId from this PortalPage
void	deletePortletConfigs() Remove all the PortletConfiguration's contained within this PortalPage
List	getColumn(int idx)
int	getColumnCount()
List	getColumns()
String	getDescription() A general description of the entity.
Long	getFavouriteCount() Used as a rough guide to how many people favourited this object.
Long	getId() The id of the entity.
List	getLeftPortletConfigs()
String	getName() The name of the entity.
PortletConfiguration	getPortletConfig(Long portletConfigId) Returns the FIRST PortletConfiguration inside the PortalPage identified by portletConfigId
List	getPortletConfigurations() Returns the list of PortletConfiguration objects inside the PortalPage
List	getPortletConfigurations(String portletKey) Returns the ALL the PortletConfiguration's inside the PortalPage which have a Portlet identified by portletKey
List	getRightPortletConfigs()
boolean	isSystemDefaultPortalPage()
void	movePortletPositionColumn(Long portletConfigId, Integer column)
void	movePortletPositionFirst(Long portletConfigId)
void	movePortletPositionLast(Long portletConfigId)
void	movePortletPositionRow(Long portletId, boolean forward)
void	setDescription(String description) Sets the description of the PortalPage
void	setName(String name) Sets the name of the PortalPage
void	setPermissions(SharedEntity.SharePermissions sharePermissions) Sets the SharePermission objects associated with this object
void	setPortletConfigurations(List configs) Set the portlets on the portalpage.

Methods inherited from interface com.atlassian.jira.sharing.SharedEntity

getEntityType, getOwnerUserName, getPermissions

Field Detail

ENTITY_TYPE

static final SharedEntity.TypeDescriptor ENTITY_TYPE

This is the SharedEntity type, eg "PortalPage"

Method Detail

getName

String getName()

Description copied from interface: SharedEntity

The name of the entity.

Specified by:

getName in interface SharedEntity

Returns:

the name of the PortalPage

setName

void setName(String name)

Sets the name of the PortalPage

Parameters:

name - the name of the PortalPage

getDescription

String getDescription()

Description copied from interface: SharedEntity

A general description of the entity.

Specified by:

getDescription in interface SharedEntity

Returns:

the description of the PortalPage

setDescription

void setDescription(String description)

Sets the description of the PortalPage

Parameters:

description - the description of the PortalPage

getFavouriteCount

Long getFavouriteCount()

Used as a rough guide to how many people favourited this object. A sort of popularity count

Specified by:

getFavouriteCount in interface Favourite

Returns:

a non null count of how many people have favourited this PortalPage

setPermissions

void setPermissions(SharedEntity.SharePermissions sharePermissions)

Sets the SharePermission objects associated with this object

Parameters:

sharePermissions - the set of SharePermission's

getId

Long getId()

Description copied from interface: SharedEntity

The id of the entity.

Specified by:

getId in interface SharedEntity

Returns:

the id of the PortalPage

isSystemDefaultPortalPage

boolean isSystemDefaultPortalPage()

Returns:

true if the PortalPage represents the system default PortalPage in JIRA

getPortletConfigurations

List getPortletConfigurations()

Returns the list of PortletConfiguration objects inside the PortalPage

Returns:

the list of PortletConfiguration objects inside the PortalPage

setPortletConfigurations

void setPortletConfigurations(List configs)

Set the portlets on the portalpage. The portlets will be layed within the portal page on during this call.

Parameters:

configs - the portlets to be set on this page.

getPortletConfig

PortletConfiguration getPortletConfig(Long portletConfigId)

Returns the FIRST PortletConfiguration inside the PortalPage identified by portletConfigId

Parameters:

portletConfigId - the if of the PortletConfiguration to retrieve

Returns:

the PortletConfiguration inside the PortalPage or null if its not there

getPortletConfigurations

List getPortletConfigurations(String portletKey)

Returns the ALL the PortletConfiguration's inside the PortalPage which have a Portlet identified by portletKey

Parameters:

portletKey - the key of the contained Portlet

Returns:

a List of PortletConfiguration's inside the PortalPage or an empty list of its not there

deletePortletConfig

void deletePortletConfig(Long portletConfigId)

Deletes the PortletConfiguration with the portletConfigId from this PortalPage

Parameters:

portletConfigId - the id of the PortletConfiguration

deletePortletConfigs

void deletePortletConfigs()

Remove all the PortletConfiguration's contained within this PortalPage

addPortletConfig

void addPortletConfig(PortletConfiguration portletConfiguration)

This adds a PortletConfiguration to the PortalPage. In fact this method is not expected to be directly called outside the PortalPageService.addPortalPagePortletConfiguration(com.atlassian.jira.bc.JiraServiceContext, PortalPage, String, int, int) method.

Parameters:

portletConfiguration - the PortletConfiguration to add

getLeftPortletConfigs

List getLeftPortletConfigs()

getRightPortletConfigs

List getRightPortletConfigs()

movePortletPositionColumn

void movePortletPositionColumn(Long portletConfigId,
                               Integer column)

movePortletPositionRow

void movePortletPositionRow(Long portletId,
                            boolean forward)

movePortletPositionFirst

void movePortletPositionFirst(Long portletConfigId)

movePortletPositionLast

void movePortletPositionLast(Long portletConfigId)

getColumnCount

int getColumnCount()

getColumns

List getColumns()

getColumn

List getColumn(int idx)

copy

PortalPage copy()

Create a copy of the current portal page.

Returns:

a copy of the current portal page.