Package com.appiancorp.suiteapi.portal
Class Page
java.lang.Object
com.appiancorp.suiteapi.portal.PageInfo
com.appiancorp.suiteapi.portal.Page
- All Implemented Interfaces:
LocalId
,Serializable
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Holds all the information about a portal page necessary for rendering.
A Portal page has no contingent information (thus it can be cached across
users and time) except for its state (see
getState()
), which depends
on the method used to retrieve the page object and the user.
If a caching mechanism is implemented for page rendering, the state field
should be
ignored when the page object is retrieved from the cache.- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.Fields inherited from class com.appiancorp.suiteapi.portal.PageInfo
PAGE_ACCESS_LEVEL_ADMIN, PAGE_ACCESS_LEVEL_EDIT, PAGE_ACCESS_LEVEL_NONE, PAGE_ACCESS_LEVEL_VIEW, TYPE_CUSTOM, TYPE_DASHBOARD, TYPE_PORTAL_PAGE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.The current user's access level with respect to this page.com.appiancorp.type.TypeRef
Deprecated.Returns the id of the data type that defines the structure of this page's data context.Deprecated.The id of the user who holds the lock on the draft of this page, or an empty string if it is not locked.Portlet[][]
Deprecated.The portlets that must be rendered in this page.Deprecated.The role map.int
getState()
Deprecated.Holds the current state of this portal page.Deprecated.The name of the template that must be used to render this page.getUuid()
Deprecated.Returns the UUID of this page.int
Deprecated.Indicates the number of zones in this page's template.boolean
Deprecated.Indicates whether changes to this page require approval or not.void
setAccessLevel
(int p_) Deprecated.SeegetAccessLevel()
void
setApprovalRequired
(boolean p_) Deprecated.void
setDataContextType
(com.appiancorp.type.TypeRef dataContextType) Deprecated.Sets the data type id of this page's data context.void
setDraftOwner
(String p_) Deprecated.SeegetDraftOwner()
void
setPortlets
(Portlet[][] p_) Deprecated.SeegetPortlets()
void
setRoleMap
(PageRoleMap role_) Deprecated.SeegetRoleMap()
void
setState
(int p_) Deprecated.SeegetState()
void
setTemplate
(String p_) Deprecated.SeegetTemplate()
void
Deprecated.Set the UUID of this page.void
setZoneCount
(int p_) Deprecated.SeegetZoneCount()
toString()
Deprecated.Methods inherited from class com.appiancorp.suiteapi.portal.PageInfo
getCategoryId, getCreator, getDateCreated, getDateModified, getDescription, getGroup, getId, getIds, getModifier, getName, getType, getUrl, isPublic, setCategoryId, setCreator, setDateCreated, setDateModified, setDescription, setGroup, setId, setModifier, setName, setPublic, setType, setUrl
-
Field Details
-
STATE_NEW_DRAFT
public static final int STATE_NEW_DRAFTDeprecated.- See Also:
-
STATE_NEW_SUBMITTED
public static final int STATE_NEW_SUBMITTEDDeprecated.- See Also:
-
STATE_PUBLISHED
public static final int STATE_PUBLISHEDDeprecated.- See Also:
-
STATE_DRAFT
public static final int STATE_DRAFTDeprecated.- See Also:
-
STATE_SUBMITTED
public static final int STATE_SUBMITTEDDeprecated.- See Also:
-
STATE_LOCKED
public static final int STATE_LOCKEDDeprecated.- See Also:
-
SORT_BY_NAME
Deprecated. -
SORT_BY_DESCRIPTION
Deprecated. -
SORT_BY_STATE
Deprecated. -
SORT_BY_DRAFT_OWNER
Deprecated. -
SORT_BY_APPROVAL_REQUIRED
Deprecated. -
SORT_BY_CREATOR
Deprecated. -
SORT_BY_DATE_CREATED
Deprecated. -
SORT_BY_DATE_MODIFIED
Deprecated. -
SORT_BY_CATEGORY_ID
Deprecated. -
SORT_BY_TEMPLATE
Deprecated. -
SORT_BY_MODIFIER
Deprecated. -
SORT_BY_PUBLIC
Deprecated. -
SORT_BY_ZONE_COUNT
Deprecated. -
SORT_BY_URL
Deprecated. -
SORT_BY_TYPE
Deprecated. -
SORT_BY_ID
Deprecated. -
SORT_BY_GROUP
Deprecated. -
SORT_BY_ACCESS_LEVEL
Deprecated.
-
-
Constructor Details
-
Page
public Page()Deprecated. -
Page
Deprecated.
-
-
Method Details
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Deprecated.Returns the UUID of this page. This field is not populated unless:- the page has previously been exported
- the page was assigned a UUID when it was created
- the page was assigned a UUID using the Import/Export API
-
setUuid
Deprecated.Set the UUID of this page. This value is ignored, except when the page is being created. -
getZoneCount
public int getZoneCount()Deprecated.Indicates the number of zones in this page's template. Must be between 1 and 20, inclusive. Out of the box templates provided are tightly coupled with the zone count and don't allow customizing the zone count; modifying this attribute for a page could result in broken UI.- See Also:
-
setZoneCount
public void setZoneCount(int p_) Deprecated.SeegetZoneCount()
-
getState
public int getState()Deprecated.Holds the current state of this portal page. Possible values are the STATE constants defined in this class. NOTE: page state is determined by the database, and cannot be modified by calling setState. -
setState
public void setState(int p_) Deprecated.SeegetState()
-
getDraftOwner
Deprecated.The id of the user who holds the lock on the draft of this page, or an empty string if it is not locked. -
setDraftOwner
Deprecated.SeegetDraftOwner()
-
isApprovalRequired
public boolean isApprovalRequired()Deprecated.Indicates whether changes to this page require approval or not. Iftrue
only portal administrators (seeAdministrationService.setAdministratorGroup(java.lang.Long)
) and approvers in this page's role map are allowed to push the current draft to production. -
setApprovalRequired
public void setApprovalRequired(boolean p_) Deprecated. -
getTemplate
Deprecated.The name of the template that must be used to render this page. In the default implementation of the portal application, the template is a tiles definition. However implemented, the template must make available at least one "zone". Zones contain each a list of portlets, and display them in a template-specific manner. Out of the box templates we procie- See Also:
-
setTemplate
Deprecated.SeegetTemplate()
-
getPortlets
Deprecated.The portlets that must be rendered in this page. The first dimension of the array contains one item per zone in this page's template. Each item is a list of portlets that must be rendered in the corresponding zone. -
setPortlets
Deprecated.SeegetPortlets()
-
getAccessLevel
public int getAccessLevel()Deprecated.The current user's access level with respect to this page. This field is calculated based on thePageRoleMap
and the user making the call.- Returns:
- The access level, see constants on
PageInfo
.
-
setAccessLevel
public void setAccessLevel(int p_) Deprecated.SeegetAccessLevel()
-
getRoleMap
Deprecated.The role map. SeePageRoleMap
.- Returns:
- The role map.
-
setRoleMap
Deprecated.SeegetRoleMap()
-
getDataContextType
public com.appiancorp.type.TypeRef getDataContextType()Deprecated.Returns the id of the data type that defines the structure of this page's data context. If a context type is configured at design time, an instance of the data type -a value- is expected at runtime.- Returns:
- data type id of this page's data context
-
setDataContextType
public void setDataContextType(com.appiancorp.type.TypeRef dataContextType) Deprecated.Sets the data type id of this page's data context. See#getDataContext()
- Parameters:
dataContextType
- data type id of this page's data context
-
toString
Deprecated.
-