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 @PageDataType public class Page extends PageInfo
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 Details

    • STATE_NEW_DRAFT

      public static final int STATE_NEW_DRAFT
      Deprecated.
      See Also:

    • STATE_NEW_SUBMITTED

      public static final int STATE_NEW_SUBMITTED
      Deprecated.
      See Also:

    • STATE_PUBLISHED

      public static final int STATE_PUBLISHED
      Deprecated.
      See Also:

    • STATE_DRAFT

      public static final int STATE_DRAFT
      Deprecated.
      See Also:

    • STATE_SUBMITTED

      public static final int STATE_SUBMITTED
      Deprecated.
      See Also:

    • STATE_LOCKED

      public static final int STATE_LOCKED
      Deprecated.
      See Also:

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Deprecated.

    • SORT_BY_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION
      Deprecated.

    • SORT_BY_STATE

      public static final Integer SORT_BY_STATE
      Deprecated.

    • SORT_BY_DRAFT_OWNER

      public static final Integer SORT_BY_DRAFT_OWNER
      Deprecated.

    • SORT_BY_APPROVAL_REQUIRED

      public static final Integer SORT_BY_APPROVAL_REQUIRED
      Deprecated.

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Deprecated.

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Deprecated.

    • SORT_BY_DATE_MODIFIED

      public static final Integer SORT_BY_DATE_MODIFIED
      Deprecated.

    • SORT_BY_CATEGORY_ID

      public static final Integer SORT_BY_CATEGORY_ID
      Deprecated.

    • SORT_BY_TEMPLATE

      public static final Integer SORT_BY_TEMPLATE
      Deprecated.

    • SORT_BY_MODIFIER

      public static final Integer SORT_BY_MODIFIER
      Deprecated.

    • SORT_BY_PUBLIC

      public static final Integer SORT_BY_PUBLIC
      Deprecated.

    • SORT_BY_ZONE_COUNT

      public static final Integer SORT_BY_ZONE_COUNT
      Deprecated.

    • SORT_BY_URL

      public static final Integer SORT_BY_URL
      Deprecated.

    • SORT_BY_TYPE

      public static final Integer SORT_BY_TYPE
      Deprecated.

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.

    • SORT_BY_GROUP

      public static final Integer SORT_BY_GROUP
      Deprecated.

    • SORT_BY_ACCESS_LEVEL

      public static final Integer SORT_BY_ACCESS_LEVEL
      Deprecated.

  • Constructor Details

    • Page

      public Page()
      Deprecated.

    • Page

      public Page(String name, String template, int zoneCount)
      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

      public void setUuid(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:

    • 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 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(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 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:

    • setTemplate

      public void setTemplate(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 String toString()
      Deprecated.
      Overrides:
      toString in class PageInfo