com.appiancorp.suiteapi.portal

Class Page

java.lang.Object

com.appiancorp.suiteapi.portal.PageInfo

com.appiancorp.suiteapi.portal.Page

All Implemented Interfaces:

LocalId, java.io.Serializable

Deprecated.

The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
 @PageDataType
public class Page
extends PageInfo

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:

PageService, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_ACCESS_LEVEL Deprecated.
static java.lang.Integer	SORT_BY_APPROVAL_REQUIRED Deprecated.
static java.lang.Integer	SORT_BY_CATEGORY_ID Deprecated.
static java.lang.Integer	SORT_BY_CREATOR Deprecated.
static java.lang.Integer	SORT_BY_DATE_CREATED Deprecated.
static java.lang.Integer	SORT_BY_DATE_MODIFIED Deprecated.
static java.lang.Integer	SORT_BY_DESCRIPTION Deprecated.
static java.lang.Integer	SORT_BY_DRAFT_OWNER Deprecated.
static java.lang.Integer	SORT_BY_GROUP Deprecated.
static java.lang.Integer	SORT_BY_ID Deprecated.
static java.lang.Integer	SORT_BY_MODIFIER Deprecated.
static java.lang.Integer	SORT_BY_NAME Deprecated.
static java.lang.Integer	SORT_BY_PUBLIC Deprecated.
static java.lang.Integer	SORT_BY_STATE Deprecated.
static java.lang.Integer	SORT_BY_TEMPLATE Deprecated.
static java.lang.Integer	SORT_BY_TYPE Deprecated.
static java.lang.Integer	SORT_BY_URL Deprecated.
static java.lang.Integer	SORT_BY_ZONE_COUNT Deprecated.
static int	STATE_DRAFT Deprecated.
static int	STATE_LOCKED Deprecated.
static int	STATE_NEW_DRAFT Deprecated.
static int	STATE_NEW_SUBMITTED Deprecated.
static int	STATE_PUBLISHED Deprecated.
static int	STATE_SUBMITTED 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

Constructors

Constructor and Description
Page() Deprecated.
Page(java.lang.String name, java.lang.String template, int zoneCount) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	getAccessLevel() Deprecated. The current user's access level with respect to this page.
com.appiancorp.type.TypeRef	getDataContextType() Deprecated. Returns the id of the data type that defines the structure of this page's data context.
java.lang.String	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.
Portlet[][]	getPortlets() Deprecated. The portlets that must be rendered in this page.
PageRoleMap	getRoleMap() Deprecated. The role map.
int	getState() Deprecated. Holds the current state of this portal page.
java.lang.String	getTemplate() Deprecated. The name of the template that must be used to render this page.
java.lang.String	getUuid() Deprecated. Returns the UUID of this page.
int	getZoneCount() Deprecated. Indicates the number of zones in this page's template.
boolean	isApprovalRequired() Deprecated. Indicates whether changes to this page require approval or not.
void	setAccessLevel(int p_) Deprecated. See getAccessLevel()
void	setApprovalRequired(boolean p_) Deprecated. See isApprovalRequired()
void	setDataContextType(com.appiancorp.type.TypeRef dataContextType) Deprecated. Sets the data type id of this page's data context.
void	setDraftOwner(java.lang.String p_) Deprecated. See getDraftOwner()
void	setPortlets(Portlet[][] p_) Deprecated. See getPortlets()
void	setRoleMap(PageRoleMap role_) Deprecated. See getRoleMap()
void	setState(int p_) Deprecated. See getState()
void	setTemplate(java.lang.String p_) Deprecated. See getTemplate()
void	setUuid(java.lang.String uuid) Deprecated. Set the UUID of this page.
void	setZoneCount(int p_) Deprecated. See getZoneCount()
java.lang.String	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATE_NEW_DRAFT

public static final int STATE_NEW_DRAFT

Deprecated.

See Also:

Constant Field Values

STATE_NEW_SUBMITTED

public static final int STATE_NEW_SUBMITTED

Deprecated.

See Also:

Constant Field Values

STATE_PUBLISHED

public static final int STATE_PUBLISHED

Deprecated.

See Also:

Constant Field Values

STATE_DRAFT

public static final int STATE_DRAFT

Deprecated.

See Also:

Constant Field Values

STATE_SUBMITTED

public static final int STATE_SUBMITTED

Deprecated.

See Also:

Constant Field Values

STATE_LOCKED

public static final int STATE_LOCKED

Deprecated.

See Also:

Constant Field Values

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Deprecated.

SORT_BY_DESCRIPTION

public static final java.lang.Integer SORT_BY_DESCRIPTION

Deprecated.

SORT_BY_STATE

public static final java.lang.Integer SORT_BY_STATE

Deprecated.

SORT_BY_DRAFT_OWNER

public static final java.lang.Integer SORT_BY_DRAFT_OWNER

Deprecated.

SORT_BY_APPROVAL_REQUIRED

public static final java.lang.Integer SORT_BY_APPROVAL_REQUIRED

Deprecated.

SORT_BY_CREATOR

public static final java.lang.Integer SORT_BY_CREATOR

Deprecated.

SORT_BY_DATE_CREATED

public static final java.lang.Integer SORT_BY_DATE_CREATED

Deprecated.

SORT_BY_DATE_MODIFIED

public static final java.lang.Integer SORT_BY_DATE_MODIFIED

Deprecated.

SORT_BY_CATEGORY_ID

public static final java.lang.Integer SORT_BY_CATEGORY_ID

Deprecated.

SORT_BY_TEMPLATE

public static final java.lang.Integer SORT_BY_TEMPLATE

Deprecated.

SORT_BY_MODIFIER

public static final java.lang.Integer SORT_BY_MODIFIER

Deprecated.

SORT_BY_PUBLIC

public static final java.lang.Integer SORT_BY_PUBLIC

Deprecated.

SORT_BY_ZONE_COUNT

public static final java.lang.Integer SORT_BY_ZONE_COUNT

Deprecated.

SORT_BY_URL

public static final java.lang.Integer SORT_BY_URL

Deprecated.

SORT_BY_TYPE

public static final java.lang.Integer SORT_BY_TYPE

Deprecated.

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Deprecated.

SORT_BY_GROUP

public static final java.lang.Integer SORT_BY_GROUP

Deprecated.

SORT_BY_ACCESS_LEVEL

public static final java.lang.Integer SORT_BY_ACCESS_LEVEL

Deprecated.

Constructor Detail

Page

public Page()

Deprecated.

Page

public Page(java.lang.String name,
            java.lang.String template,
            int zoneCount)

Deprecated.

Method Detail

getUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.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

public void setUuid(java.lang.String uuid)

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:

getTemplate()

setZoneCount

public void setZoneCount(int p_)

Deprecated.

See getZoneCount()

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.

See getState()

getDraftOwner

public java.lang.String 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

public void setDraftOwner(java.lang.String p_)

Deprecated.

See getDraftOwner()

isApprovalRequired

public boolean isApprovalRequired()

Deprecated.

Indicates whether changes to this page require approval or not. If true only portal administrators (see AdministrationService.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.

See isApprovalRequired()

getTemplate

public java.lang.String 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:

getZoneCount()

setTemplate

public void setTemplate(java.lang.String p_)

Deprecated.

See getTemplate()

getPortlets

public Portlet[][] 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

public void setPortlets(Portlet[][] p_)

Deprecated.

See getPortlets()

getAccessLevel

public int getAccessLevel()

Deprecated.

The current user's access level with respect to this page. This field is calculated based on the PageRoleMap and the user making the call.

Returns:

The access level, see constants on PageInfo.

setAccessLevel

public void setAccessLevel(int p_)

Deprecated.

See getAccessLevel()

getRoleMap

public PageRoleMap getRoleMap()

Deprecated.

The role map. See PageRoleMap.

Returns:

The role map.

setRoleMap

public void setRoleMap(PageRoleMap role_)

Deprecated.

See getRoleMap()

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

public java.lang.String toString()

Deprecated.

Overrides:

toString in class PageInfo