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.
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 Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final Integer
Deprecated.A constant for sorting portal pages by the access levelstatic final Integer
Deprecated.A constant for sorting portal pages by the Id of the page Categorystatic final Integer
Deprecated.A constant for sorting portal pages by the creator of the pagestatic final Integer
Deprecated.A constant for sorting portal pages by the date that the page was createdstatic final Integer
Deprecated.A constant for sorting portal pages by the date that the page was last modifiedstatic final Integer
Deprecated.A constant for sorting portal pages by descriptionstatic final Integer
Deprecated.A constant for sorting portal pages by the group to which the page is associated.static final Integer
Deprecated.A constant for sorting portal pages by the IDstatic final Integer
Deprecated.A constant for sorting portal pages by the last user to modify the pagestatic final Integer
Deprecated.A constant for sorting portal pages by namestatic final Integer
Deprecated.A constant for sorting portal pages by whether the page is public or notstatic final Integer
Deprecated.A constant for sorting portal pages by the page typestatic final Integer
Deprecated.A constant for sorting portal pages by URL (This only applies to custom pages)static final int
Deprecated.static final int
Deprecated.static final int
Deprecated. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.The category that this page is associated to, if any.Deprecated.The user id of the creator of this page.Deprecated.The timestamp indicating when this page was created.Deprecated.The timestamp indicating when this page was last modified.Deprecated.A text description of this pagegetGroup()
Deprecated.The group associated to this page.getId()
Deprecated.The unique identifier of this pagestatic Long[]
Deprecated.Get the ids (as a Long array) from an array of page objects.Deprecated.The user id of the last person who has modified this page.getName()
Deprecated.The display name/title of this pageint
getType()
Deprecated.Returns the page type.getUrl()
Deprecated.Returns the URL of a Custom Page.boolean
isPublic()
Deprecated.Indicates whether this page is publicly viewable or it has viewer rights determined by the role map.void
setCategoryId
(Long p_) Deprecated.SeegetCategoryId()
void
setCreator
(String p_) Deprecated.SeegetCreator()
void
Deprecated.SeegetDateCreated()
void
Deprecated.void
setDescription
(String p_) Deprecated.SeegetDescription()
void
Deprecated.SeegetGroup()
void
Deprecated.SeegetId()
void
setModifier
(String p_) Deprecated.SeegetModifier()
void
Deprecated.SeegetName()
void
setPublic
(boolean p_) Deprecated.SeeisPublic()
void
setType
(int type_) Deprecated.Sets the page type.void
Deprecated.Sets the URL of a Custom Page.toString()
Deprecated.
-
Field Details
-
SORT_BY_NAME
Deprecated.A constant for sorting portal pages by name -
SORT_BY_DESCRIPTION
Deprecated.A constant for sorting portal pages by description -
SORT_BY_CREATOR
Deprecated.A constant for sorting portal pages by the creator of the page -
SORT_BY_MODIFIER
Deprecated.A constant for sorting portal pages by the last user to modify the page -
SORT_BY_DATE_CREATED
Deprecated.A constant for sorting portal pages by the date that the page was created -
SORT_BY_DATE_MODIFIED
Deprecated.A constant for sorting portal pages by the date that the page was last modified -
SORT_BY_CATEGORY_ID
Deprecated.A constant for sorting portal pages by the Id of the page Category -
SORT_BY_PUBLIC
Deprecated.A constant for sorting portal pages by whether the page is public or not -
SORT_BY_URL
Deprecated.A constant for sorting portal pages by URL (This only applies to custom pages) -
SORT_BY_TYPE
Deprecated.A constant for sorting portal pages by the page type -
SORT_BY_ID
Deprecated.A constant for sorting portal pages by the ID -
SORT_BY_GROUP
Deprecated.A constant for sorting portal pages by the group to which the page is associated. -
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_NONEDeprecated.- See Also:
-
PAGE_ACCESS_LEVEL_VIEW
public static final int PAGE_ACCESS_LEVEL_VIEWDeprecated.- See Also:
-
PAGE_ACCESS_LEVEL_EDIT
public static final int PAGE_ACCESS_LEVEL_EDITDeprecated.- See Also:
-
PAGE_ACCESS_LEVEL_ADMIN
public static final int PAGE_ACCESS_LEVEL_ADMINDeprecated.- See Also:
-
TYPE_PORTAL_PAGE
public static final int TYPE_PORTAL_PAGEDeprecated.- See Also:
-
TYPE_CUSTOM
public static final int TYPE_CUSTOMDeprecated.- See Also:
-
TYPE_DASHBOARD
public static final int TYPE_DASHBOARDDeprecated.- See Also:
-
-
Constructor Details
-
PageInfo
public PageInfo()Deprecated. -
PageInfo
Deprecated.
-
-
Method Details
-
getId
Deprecated.The unique identifier of this page -
setId
Deprecated.SeegetId()
-
getName
Deprecated.The display name/title of this page -
setName
Deprecated.SeegetName()
-
getDescription
Deprecated.A text description of this page -
setDescription
Deprecated.SeegetDescription()
-
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
Deprecated.SeegetCreator()
-
getModifier
Deprecated.The user id of the last person who has modified this page. -
setModifier
Deprecated.SeegetModifier()
-
getDateCreated
Deprecated.The timestamp indicating when this page was created. -
setDateCreated
Deprecated.SeegetDateCreated()
-
getDateModified
Deprecated.The timestamp indicating when this page was last modified. -
setDateModified
Deprecated. -
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 benull
. -
setGroup
Deprecated.SeegetGroup()
-
getCategoryId
Deprecated.The category that this page is associated to, if any.- See Also:
-
setCategoryId
Deprecated.SeegetCategoryId()
-
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.SeeisPublic()
-
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
Deprecated.Returns the URL of a Custom Page.- Returns:
- The URL of a Custom Page.
-
setUrl
Deprecated.Sets the URL of a Custom Page.- Parameters:
url_
- the new URL of the Custom Page.
-
toString
Deprecated. -
getIds
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
-