@PublicApi public final class PortalPage extends Object implements SharedEntity
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.
Modifier and Type | Class and Description |
---|---|
static class |
PortalPage.Builder |
SharedEntity.Identifier, SharedEntity.SharePermissions, SharedEntity.TypeDescriptor<S extends SharedEntity>
Modifier and Type | Field and Description |
---|---|
static SharedEntity.TypeDescriptor<PortalPage> |
ENTITY_TYPE
This is the
SharedEntity type, eg "PortalPage" |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getDescription()
A general description of the entity.
|
SharedEntity.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.
|
com.atlassian.gadgets.dashboard.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() |
public static final SharedEntity.TypeDescriptor<PortalPage> ENTITY_TYPE
SharedEntity
type, eg "PortalPage"public Long getId()
SharedEntity
getId
in interface SharedEntity
public Long getVersion()
public boolean isSystemDefaultPortalPage()
public String getName()
SharedEntity
getName
in interface SharedEntity
public String getDescription()
SharedEntity
getDescription
in interface SharedEntity
public ApplicationUser getOwner()
getOwner
in interface SharedEntity
public String getOwnerUserName()
getOwnerUserName
in interface SharedEntity
public com.atlassian.gadgets.dashboard.Layout getLayout()
public Long getFavouriteCount()
Favourite
getFavouriteCount
in interface Favourite
public final SharedEntity.TypeDescriptor<PortalPage> getEntityType()
SharedEntity
getEntityType
in interface SharedEntity
public SharedEntity.SharePermissions getPermissions()
SharedEntity
getPermissions
in interface SharedEntity
public static PortalPage.Builder portalPage(PortalPage page)
public static PortalPage.Builder id(Long id)
public static PortalPage.Builder name(String name)
Copyright © 2002-2021 Atlassian. All Rights Reserved.