@PublicApi public final class

PortalPage

extends Object
implements SharedEntity
java.lang.Object
   ↳ com.atlassian.jira.portal.PortalPage

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Nested Classes
class PortalPage.Builder  
Fields
public static final TypeDescriptor<PortalPage> ENTITY_TYPE This is the SharedEntity type, eg "PortalPage"
Public Methods
boolean equals(Object obj)
String getDescription()
A general description of the entity.
final TypeDescriptor<PortalPage> getEntityType()
The type of entity it is.
Long getFavouriteCount()
The number of users who have marked this entity as one of their favourites.
Long getId()
The id of the entity.
Layout getLayout()
String getName()
The name of the entity.
ApplicationUser getOwner()
String getOwnerUserName()
SharedEntity.SharePermissions getPermissions()
The permissions for this entity.
Long getVersion()
int hashCode()
static PortalPage.Builder id(Long id)
boolean isSystemDefaultPortalPage()
static PortalPage.Builder name(String name)
static PortalPage.Builder portalPage(PortalPage page)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.favourites.Favourite
From interface com.atlassian.jira.sharing.SharedEntity

Fields

public static final TypeDescriptor<PortalPage> ENTITY_TYPE

This is the SharedEntity type, eg "PortalPage"

Public Methods

public boolean equals (Object obj)

public String getDescription ()

A general description of the entity.

Returns
  • the description. May be null or empty.

public final TypeDescriptor<PortalPage> getEntityType ()

The type of entity it is. Examples include SearchRequest ("SearchRequest") and PortalPage ("PortalPage")

Returns
  • the type of entity.

public Long getFavouriteCount ()

The number of users who have marked this entity as one of their favourites.

Returns
  • long the user count

public Long getId ()

The id of the entity.

Returns
  • the id. May be null if not yet persisted. Some components may not accept a non-persisted entity.

public Layout getLayout ()

public String getName ()

The name of the entity.

Returns
  • the name. Must not be null or empty.

public ApplicationUser getOwner ()

public String getOwnerUserName ()

public SharedEntity.SharePermissions getPermissions ()

The permissions for this entity.

Returns
  • the permissions object. Must not be null.

public Long getVersion ()

public int hashCode ()

public static PortalPage.Builder id (Long id)

public boolean isSystemDefaultPortalPage ()

public static PortalPage.Builder name (String name)

public static PortalPage.Builder portalPage (PortalPage page)

public String toString ()