Package com.appiancorp.suiteapi.portal

Class PageInfo

java.lang.Object
com.appiancorp.suiteapi.portal.PageInfo
All Implemented Interfaces:
LocalId, Serializable
Direct Known Subclasses:
Page
@Deprecated public class PageInfo extends Object implements LocalId
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Provides basic displayable information about pages. For details about the properties, see the documentation of Page.
See Also:

  • Field Details

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Deprecated.
      A constant for sorting portal pages by name

    • SORT_BY_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION
      Deprecated.
      A constant for sorting portal pages by description

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Deprecated.
      A constant for sorting portal pages by the creator of the page

    • SORT_BY_MODIFIER

      public static final Integer SORT_BY_MODIFIER
      Deprecated.
      A constant for sorting portal pages by the last user to modify the page

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Deprecated.
      A constant for sorting portal pages by the date that the page was created

    • SORT_BY_DATE_MODIFIED

      public static final Integer SORT_BY_DATE_MODIFIED
      Deprecated.
      A constant for sorting portal pages by the date that the page was last modified

    • SORT_BY_CATEGORY_ID

      public static final Integer SORT_BY_CATEGORY_ID
      Deprecated.
      A constant for sorting portal pages by the Id of the page Category

    • SORT_BY_PUBLIC

      public static final Integer SORT_BY_PUBLIC
      Deprecated.
      A constant for sorting portal pages by whether the page is public or not

    • SORT_BY_URL

      public static final Integer SORT_BY_URL
      Deprecated.
      A constant for sorting portal pages by URL (This only applies to custom pages)

    • SORT_BY_TYPE

      public static final Integer SORT_BY_TYPE
      Deprecated.
      A constant for sorting portal pages by the page type

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.
      A constant for sorting portal pages by the ID

    • SORT_BY_GROUP

      public static final Integer SORT_BY_GROUP
      Deprecated.
      A constant for sorting portal pages by the group to which the page is associated.

    • SORT_BY_ACCESS_LEVEL

      public static final Integer SORT_BY_ACCESS_LEVEL
      Deprecated.
      A constant for sorting portal pages by the access level

    • PAGE_ACCESS_LEVEL_NONE

      public static final int PAGE_ACCESS_LEVEL_NONE
      Deprecated.
      See Also:

    • PAGE_ACCESS_LEVEL_VIEW

      public static final int PAGE_ACCESS_LEVEL_VIEW
      Deprecated.
      See Also:

    • PAGE_ACCESS_LEVEL_EDIT

      public static final int PAGE_ACCESS_LEVEL_EDIT
      Deprecated.
      See Also:

    • PAGE_ACCESS_LEVEL_ADMIN

      public static final int PAGE_ACCESS_LEVEL_ADMIN
      Deprecated.
      See Also:

    • TYPE_PORTAL_PAGE

      public static final int TYPE_PORTAL_PAGE
      Deprecated.
      See Also:

    • TYPE_CUSTOM

      public static final int TYPE_CUSTOM
      Deprecated.
      See Also:

    • TYPE_DASHBOARD

      public static final int TYPE_DASHBOARD
      Deprecated.
      See Also:

  • Constructor Details

    • PageInfo

      public PageInfo()
      Deprecated.

    • PageInfo

      public PageInfo(String name)
      Deprecated.

  • Method Details

    • getId

      public Long getId()
      Deprecated.
      The unique identifier of this page
      Specified by:
      getId in interface LocalId
      Returns:
      Object's Id
      See Also:

    • setId

      public void setId(Long id_)
      Deprecated.
      See getId()
      Specified by:
      setId in interface LocalId
      Parameters:
      id_ - Id to set
      See Also:

    • getName

      public String getName()
      Deprecated.
      The display name/title of this page

    • setName

      public void setName(String name_)
      Deprecated.
      See getName()

    • getDescription

      public String getDescription()
      Deprecated.
      A text description of this page

    • setDescription

      public void setDescription(String p_)
      Deprecated.
      See getDescription()

    • getCreator

      public String getCreator()
      Deprecated.
      The user id of the creator of this page. The creator of a page has complete ownership (i.e. ADMIN access level) on the page.

    • setCreator

      public void setCreator(String p_)
      Deprecated.
      See getCreator()

    • getModifier

      public String getModifier()
      Deprecated.
      The user id of the last person who has modified this page.

    • setModifier

      public void setModifier(String p_)
      Deprecated.
      See getModifier()

    • getDateCreated

      public Timestamp getDateCreated()
      Deprecated.
      The timestamp indicating when this page was created.

    • setDateCreated

      public void setDateCreated(Timestamp p_)
      Deprecated.
      See getDateCreated()

    • getDateModified

      public Timestamp getDateModified()
      Deprecated.
      The timestamp indicating when this page was last modified.

    • setDateModified

      public void setDateModified(Timestamp p_)
      Deprecated.
      See getDateModified()

    • getGroup

      public Long getGroup()
      Deprecated.
      The group associated to this page. Administrators of this group retain complete ownership (i.e. ADMIN access level) on the page. The group can be null.

    • setGroup

      public void setGroup(Long p_)
      Deprecated.
      See getGroup()

    • getCategoryId

      public Long getCategoryId()
      Deprecated.
      The category that this page is associated to, if any.
      See Also:

    • setCategoryId

      public void setCategoryId(Long p_)
      Deprecated.
      See getCategoryId()

    • isPublic

      public boolean isPublic()
      Deprecated.
      Indicates whether this page is publicly viewable or it has viewer rights determined by the role map.

    • setPublic

      public void setPublic(boolean p_)
      Deprecated.
      See isPublic()

    • getType

      public int getType()
      Deprecated.
      Returns the page type. Current types: Portal Page and Custom Page
      Returns:
      the page type.

    • setType

      public void setType(int type_)
      Deprecated.
      Sets the page type.
      Parameters:
      type_ - The new type of page.

    • getUrl

      public String getUrl()
      Deprecated.
      Returns the URL of a Custom Page.
      Returns:
      The URL of a Custom Page.

    • setUrl

      public void setUrl(String url_)
      Deprecated.
      Sets the URL of a Custom Page.
      Parameters:
      url_ - the new URL of the Custom Page.

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • getIds

      public static Long[] getIds(PageInfo[] pages)
      Deprecated.
      Get the ids (as a Long array) from an array of page objects.
      Parameters:
      pages - an array of pages
      Returns:
      an array of the same size as the given array, containing the ids of the given pages; if given array is null, returns null