com.atlassian.jira.portal
Class PortalPage

java.lang.Object
  extended by com.atlassian.jira.portal.PortalPage
All Implemented Interfaces:
Favourite, SharedEntity

public final class PortalPage
extends java.lang.Object
implements SharedEntity

This class represents a Dashboard page in JIRA. It includes dashboard meta data (name, description) as well as information about favouriting and share permissions.

It no longer has a link to the PortletConfigurations (Gadgets) displayed on a dashboard. To get this information one should consult the PortalPageService directly.

Use the supplied PortalPage.Builder class to construct new instances of a PortalPage. This class is used to represent both System and User owned dashboards. The only restriction is that system dashboards may not have an owner.

Since:
4.1

Nested Class Summary
static class PortalPage.Builder
           
 
Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.SharedEntity
SharedEntity.Identifier, SharedEntity.SharePermissions, SharedEntity.TypeDescriptor<S extends SharedEntity>
 
Field Summary
static SharedEntity.TypeDescriptor<PortalPage> ENTITY_TYPE
          This is the SharedEntity type, eg "PortalPage"
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getDescription()
          A general description of the entity.
 SharedEntity.TypeDescriptor<PortalPage> getEntityType()
          The type of entity it is.
 java.lang.Long getFavouriteCount()
          The number of users who have marked this entity as one of their favourites.
 java.lang.Long getId()
          The id of the entity.
 com.atlassian.gadgets.dashboard.Layout getLayout()
           
 java.lang.String getName()
          The name of the entity.
 java.lang.String getOwnerUserName()
          The user name of the owner of the entity.
 SharedEntity.SharePermissions getPermissions()
          The permissions for this entity.
 java.lang.Long getVersion()
           
 int hashCode()
           
static PortalPage.Builder id(java.lang.Long id)
           
 boolean isSystemDefaultPortalPage()
           
static PortalPage.Builder name(java.lang.String name)
           
static PortalPage.Builder portalPage(PortalPage page)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ENTITY_TYPE

public static final SharedEntity.TypeDescriptor<PortalPage> ENTITY_TYPE
This is the SharedEntity type, eg "PortalPage"

Method Detail

getId

public java.lang.Long getId()
Description copied from interface: SharedEntity
The id of the entity.

Specified by:
getId in interface SharedEntity
Returns:
the id. May be null if not yet persisted. Some components may not accept a non-persisted entity.

getVersion

public java.lang.Long getVersion()

isSystemDefaultPortalPage

public boolean isSystemDefaultPortalPage()

getName

public java.lang.String getName()
Description copied from interface: SharedEntity
The name of the entity.

Specified by:
getName in interface SharedEntity
Returns:
the name. Must not be null or empty.

getDescription

public java.lang.String getDescription()
Description copied from interface: SharedEntity
A general description of the entity.

Specified by:
getDescription in interface SharedEntity
Returns:
the description. May be null or empty.

getLayout

public com.atlassian.gadgets.dashboard.Layout getLayout()

getFavouriteCount

public java.lang.Long getFavouriteCount()
Description copied from interface: Favourite
The number of users who have marked this entity as one of their favourites.

Specified by:
getFavouriteCount in interface Favourite
Returns:
long the user count

getEntityType

public final SharedEntity.TypeDescriptor<PortalPage> getEntityType()
Description copied from interface: SharedEntity
The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")

Specified by:
getEntityType in interface SharedEntity
Returns:
the type of entity.

getOwnerUserName

public java.lang.String getOwnerUserName()
Description copied from interface: SharedEntity
The user name of the owner of the entity. Will always have permission to see it and see all shares.

Specified by:
getOwnerUserName in interface SharedEntity
Returns:
The user name of the user who owns this entity. May be null for anonymous user.

getPermissions

public SharedEntity.SharePermissions getPermissions()
Description copied from interface: SharedEntity
The permissions for this entity.

Specified by:
getPermissions in interface SharedEntity
Returns:
the permissions object. Must not be null.

portalPage

public static PortalPage.Builder portalPage(PortalPage page)

id

public static PortalPage.Builder id(java.lang.Long id)

name

public static PortalPage.Builder name(java.lang.String name)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2002-2010 Atlassian. All Rights Reserved.