Interface PageNavigationService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
Defines methods for structured access to pages. Provides the ability to handle home pages for users and groups, manage tabs and bookmarks, organize pages into categories, and retrieve pages of direct interest to users.
Page categories provide a mechanism for organizing pages based on their content - pages of similar content can be associated with the same category. Similarly, pages may be associated with a group, so that members of that group may have centralized access to content pertaining to that group. Finally, home pages may be designated for users and for groups. In the former case, this page will be the first page that a user sees when logging into the application; in the latter, this page will be the first page that members of the group see when viewing group pages.
Methods of service classes can all throw the unchecked exception
ServiceException
if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException
) when an entity
to be retrieved is inaccessible, instead of returning null
.
Exceptions to this paradigm (including the use of ResultList
as
described below) are noted. All checked exceptions extend
AppianException
.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage
are provided in certain
instances for this purpose. The ResultPage
will contain the
sorted subset of results
(via Result.getResults()
), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()
).
When sorting the results for
getHomePagesForGroupsPaging(Long[], int, int, Integer, Integer)
it is important to consider the following scenarios for the sort property:
- The sort property should be one of the
SORT_BY_XXX
constant values insidePageInfo
- If the value is negative then
PageInfo.SORT_BY_NAME
will be used instead - If the value is greater than
PageInfo.SORT_BY_ACCESS_LEVEL
(12) thenPageInfo.SORT_BY_ACCESS_LEVEL
will be used instead
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList
are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()
) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList
for details.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final Long
Deprecated.A constant used to indicated that sorting hierarchical tree structures of portal pages starts at the top.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addBookmark
(Long pageId_) Deprecated.Adds the specified page to the current user's bookmarks.addCategory
(String name_, Long parentCategoryId_) Deprecated.Add a category.void
Deprecated.Deletes any references to invalid pages for that user or his member groups.PageInfo[]
Deprecated.findPagesPaging
(String searchTerms_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Searches through names and descriptions of the portal pages the current user can view.Tree[]
Deprecated.getAllCategoriesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing all categories Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category).PageInfo[]
Deprecated.getBookmarksPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing the list of bookmarked pages for the current user.Long[]
getCategoriesPageCounts
(Long[] categoryIds_) Deprecated.Gets the number of pages in each category, for a list of categoriesgetCategoryDescendants
(Long categoryId_, int levels_) Deprecated.Gets the descendants of a category up to the specified depth.PageInfo[]
getEditablePagesNotCreatedByCurrentUserPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets a ResultPage containing a list of pages editable by the current user but not created by himDeprecated.Gets the home page for the current user.getHomePageForGroup
(Long groupId_) Deprecated.Gets the home page of the specified group.PageInfo[]
getHomePagesForGroups
(Long[] groupIds_) Deprecated.getHomePagesForGroupsPaging
(Long[] groupIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing the home pages of the specified groups.getLoginData
(int bookmarkPagingStartIndex_, int bookmarkPagingBatchSize_, Integer bookmarkPagingSortProperty_, Integer bookmarkPagingSortOrder_) Deprecated.Gets aLoginData
bean containing the list of bookmarked pages for the current user, as well as a flag representing whether the user, or any of his member groups, references an invalid page.PageInfo[]
Deprecated.getPagesCreatedByCurrentUserPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing a list of pages created by the current userPageInfo[]
getPagesCreatedByUser
(String username_) Deprecated.getPagesCreatedByUserPaging
(String username_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing those pages created by the specified user that the current user has permission to view.PageInfo[]
getPagesForGroup
(Long groupId_) Deprecated.getPagesForGroupPaging
(Long groupId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing all pages that are associated with the specified group and that the user has permission to view.PageInfo[][]
getPagesForGroups
(Long[] groupIds_) Deprecated.Gets all pages that are associated with the specified groups and that the user has permission to view.PageInfo[]
getPagesInCategory
(Long categoryId_) Deprecated.getPagesInCategoryPaging
(Long categoryId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets a ResultPage containing all the pages that are in a specified category, and that the current user has permission to view.PageInfo[]
Deprecated.getPagesPendingApprovalByCurrentUserPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing a list of pages pending for approval that the current user has permission to approve.Tree[]
getRootCategories
(int levels_) Deprecated.getRootCategoriesPaging
(int levels_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category).Boolean[]
getVisiblePagesForGroups
(Long[] groupIds_) Deprecated.Discover whether each element in an array of groups has at least one associated page that the user has permission to view.void
removeBookmark
(Long pageId_) Deprecated.Removes the specified page from the current user's bookmarks.void
removeBookmarks
(Long[] pageIds_) Deprecated.Removes the specified pages from the current user's bookmarks.void
removeCategory
(Long categoryId_) Deprecated.Remove a category.void
removeCategoryAndDescendants
(Long categoryId_) Deprecated.Remove a category and all of its descendants.void
renameCategory
(Long pCategoryId_, String pCategoryName_) Deprecated.void
setGroupAssociationForPage
(Long pageId_, Long groupId_) Deprecated.Associates a page to a group and a group to a page for the page and the group specified.void
setHomePage
(Long pageId_) Deprecated.Sets the home page for the current user.void
setHomePageForAnonymous
(Long pageId_) Deprecated.anonymous user access was removed in 6.2void
setHomePageForGroup
(Long pageId_, Long groupId_) Deprecated.Sets the home page for the specified group.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
CATEGORY_TOP
Deprecated.A constant used to indicated that sorting hierarchical tree structures of portal pages starts at the top. SeegetCategoryDescendants(Long, int)
for an example. -
setHomePage$UPDATES
static final boolean setHomePage$UPDATESDeprecated.- See Also:
-
setHomePageForGroup$UPDATES
static final boolean setHomePageForGroup$UPDATESDeprecated.- See Also:
-
getHomePage$UPDATES
static final boolean getHomePage$UPDATESDeprecated.- See Also:
-
getHomePageForGroup$UPDATES
static final boolean getHomePageForGroup$UPDATESDeprecated.- See Also:
-
getHomePagesForGroupsPaging$UPDATES
static final boolean getHomePagesForGroupsPaging$UPDATESDeprecated.- See Also:
-
getHomePagesForGroups$UPDATES
static final boolean getHomePagesForGroups$UPDATESDeprecated.- See Also:
-
getVisiblePagesForGroups$UPDATES
static final boolean getVisiblePagesForGroups$UPDATESDeprecated.- See Also:
-
getPagesForGroupPaging$UPDATES
static final boolean getPagesForGroupPaging$UPDATESDeprecated.- See Also:
-
getPagesForGroup$UPDATES
static final boolean getPagesForGroup$UPDATESDeprecated.- See Also:
-
getPagesForGroups$UPDATES
static final boolean getPagesForGroups$UPDATESDeprecated.- See Also:
-
getPagesCreatedByUserPaging$UPDATES
static final boolean getPagesCreatedByUserPaging$UPDATESDeprecated.- See Also:
-
getPagesCreatedByUser$UPDATES
static final boolean getPagesCreatedByUser$UPDATESDeprecated.- See Also:
-
getPagesCreatedByCurrentUserPaging$UPDATES
static final boolean getPagesCreatedByCurrentUserPaging$UPDATESDeprecated.- See Also:
-
getPagesCreatedByCurrentUser$UPDATES
static final boolean getPagesCreatedByCurrentUser$UPDATESDeprecated.- See Also:
-
getEditablePagesNotCreatedByCurrentUserPaging$UPDATES
static final boolean getEditablePagesNotCreatedByCurrentUserPaging$UPDATESDeprecated.- See Also:
-
getEditablePagesNotCreatedByCurrentUser$UPDATES
static final boolean getEditablePagesNotCreatedByCurrentUser$UPDATESDeprecated.- See Also:
-
getPagesPendingApprovalByCurrentUserPaging$UPDATES
static final boolean getPagesPendingApprovalByCurrentUserPaging$UPDATESDeprecated.- See Also:
-
getPagesPendingApprovalByCurrentUser$UPDATES
static final boolean getPagesPendingApprovalByCurrentUser$UPDATESDeprecated.- See Also:
-
findPagesPaging$UPDATES
static final boolean findPagesPaging$UPDATESDeprecated.- See Also:
-
findPages$UPDATES
static final boolean findPages$UPDATESDeprecated.- See Also:
-
addBookmark$UPDATES
static final boolean addBookmark$UPDATESDeprecated.- See Also:
-
removeBookmark$UPDATES
static final boolean removeBookmark$UPDATESDeprecated.- See Also:
-
removeBookmarks$UPDATES
static final boolean removeBookmarks$UPDATESDeprecated.- See Also:
-
getBookmarksPaging$UPDATES
static final boolean getBookmarksPaging$UPDATESDeprecated.- See Also:
-
getBookmarks$UPDATES
static final boolean getBookmarks$UPDATESDeprecated.- See Also:
-
getCategoryDescendants$UPDATES
static final boolean getCategoryDescendants$UPDATESDeprecated.- See Also:
-
getRootCategories$UPDATES
static final boolean getRootCategories$UPDATESDeprecated.- See Also:
-
getRootCategoriesPaging$UPDATES
static final boolean getRootCategoriesPaging$UPDATESDeprecated.- See Also:
-
getCategoriesPageCounts$UPDATES
static final boolean getCategoriesPageCounts$UPDATESDeprecated.- See Also:
-
getAllCategoriesPaging$UPDATES
static final boolean getAllCategoriesPaging$UPDATESDeprecated.- See Also:
-
getAllCategories$UPDATES
static final boolean getAllCategories$UPDATESDeprecated.- See Also:
-
getPagesInCategoryPaging$UPDATES
static final boolean getPagesInCategoryPaging$UPDATESDeprecated.- See Also:
-
getPagesInCategory$UPDATES
static final boolean getPagesInCategory$UPDATESDeprecated.- See Also:
-
addCategory$UPDATES
static final boolean addCategory$UPDATESDeprecated.- See Also:
-
removeCategory$UPDATES
static final boolean removeCategory$UPDATESDeprecated.- See Also:
-
removeCategoryAndDescendants$UPDATES
static final boolean removeCategoryAndDescendants$UPDATESDeprecated.- See Also:
-
setGroupAssociationForPage$UPDATES
static final boolean setGroupAssociationForPage$UPDATESDeprecated.- See Also:
-
setHomePageForAnonymous$UPDATES
static final boolean setHomePageForAnonymous$UPDATESDeprecated.- See Also:
-
renameCategory$UPDATES
static final boolean renameCategory$UPDATESDeprecated.- See Also:
-
getLoginData$UPDATES
static final boolean getLoginData$UPDATESDeprecated.- See Also:
-
cleanUpPageReferences$UPDATES
static final boolean cleanUpPageReferences$UPDATESDeprecated.- See Also:
-
-
Method Details
-
setHomePage
void setHomePage(Long pageId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.Sets the home page for the current user.- Parameters:
pageId_
- the unique Id of the page to be set as the home page for the current user- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user is not authorized to view the pageInvalidPageException
- if the specified page does not existServiceException
- if any system-level error occursNullPointerException
- if thepageId_
isnull
InvalidAnonymousUserException
-
setHomePageForGroup
void setHomePageForGroup(Long pageId_, Long groupId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.Sets the home page for the specified group. Note: This method needs to be called to explicitly set a home page of a group. If the home page is not set explicitly, the first page associated to the group becomes the default home page of the group.This method does not validate that the group id belongs to an existent or non-deleted group, so the caller should check that the group id is valid before passing it (known issue).
- Parameters:
pageId_
- the unique Id of the page to be set as the home page for the specified groupgroupId_
- the unique Id of the specified group- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user is not an administrator of the specified group; if the user does not have permission to view the page, this exception is not thrown and the action succeeds (known issue)InvalidPageException
- if the specified page does not existServiceException
- if any system-level error occursNullPointerException
- if any argument isnull
InvalidAnonymousUserException
-
getHomePage
PageInfo getHomePage() throws PrivilegeException, InvalidAnonymousUserException, InvalidUserException, InvalidPageExceptionDeprecated.Gets the home page for the current user. Returns default home page if none was specified for the current user. If the home page is not available, that is, it has not been set or has since been deleted the current default home page is returned. If the current default home page is not available, that is, it has been deleted anInvalidPageException
is thrown.- Returns:
- a
PageInfo
object that represents the current user's home page - Throws:
PrivilegeException
- if the user does not have sufficient privileges to view the pageInvalidUserException
- if the user calling this method is invalidInvalidPageException
- if both the explicitly set home page and the default home page are not available, that is, the pages have since been deletedServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getHomePageForGroup
PageInfo getHomePageForGroup(Long groupId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.Gets the home page of the specified group.This method does not validate that the group id belongs to an existent or non-deleted group, so the caller should check that the group id is valid before passing it (known issue).
- Parameters:
groupId_
- the unique Id of the group for which the home page should be retrieved- Returns:
- a
PageInfo
object representing the home page of the specified group, or the first page associated with the group if no home page is specified. Returnsnull
if there are no pages associated with the group. - Throws:
InvalidAnonymousUserException
- never thrown (known issue)InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the user does not have sufficient privileges to view the pageNullPointerException
- if the argument isnull
InvalidPageException
- if the page associated with the group no longer existsServiceException
- if any system-level error occurs
-
getHomePagesForGroupsPaging
ResultPage getHomePagesForGroupsPaging(Long[] groupIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidPageException Deprecated.Gets aResultPage
containing the home pages of the specified groups.- Parameters:
groupIds_
- the groups for which the home page should be retrievedstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the home pages as an array ofPageInfo
objects for the requested groups,null
items if the current user does not have permission to view the corresponding pages (or if there are no pages associated with the corresponding groups). TheResultPage
will be empty if the first id in the array belongs to an non-existent or deleted group or if that group has a null home page (known issue) - Throws:
InvalidPageException
- if any of the pages associated with the groups has been deletedNullPointerException
- if the passedgroupIds_
array or any of its elements isnull
ServiceException
- if any system-level error occurs
-
getHomePagesForGroups
@Deprecated PageInfo[] getHomePagesForGroups(Long[] groupIds_) throws InvalidPageException, NullPointerException, InvalidUserException Deprecated.Gets the home pages of the specified groups.- Parameters:
groupIds_
- an array of the unique Ids of the groups whose home pages should be retrieved- Returns:
- an array of
PageInfo
objects representing the home pages of the requested groups. Anull
item will be set in the array for those groups that do not have pages associated . If the current user does not have permission to view the corresponding pages thennull
items will be set. - Throws:
InvalidPageException
- if any of the specified pages does not exist, that is, if any associated page has since been deletedNullPointerException
- if the argument isnull
InvalidUserException
- if the context of the user who made the call is invalidServiceException
- if any system-level error occurs
-
getVisiblePagesForGroups
Deprecated.Discover whether each element in an array of groups has at least one associated page that the user has permission to view. If an invalid group is passed, it returnsfalse
for that index (i.e. it does NOT have a visible page)- Parameters:
groupIds_
- the unique Ids of the groups for which the existence of associated pages should be returned.- Returns:
- an array of
Boolean
objects, parallel to the input array, where each element indicates whether the corresponding group has any associated pages. - Throws:
NullPointerException
- if the argument isnull
ServiceException
- if any system-level error occurs
-
getPagesForGroupPaging
ResultPage getPagesForGroupPaging(Long groupId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws NullPointerException Deprecated.Gets aResultPage
containing all pages that are associated with the specified group and that the user has permission to view.- Parameters:
groupId_
- the group for which the associated pages should be retrievedstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the pages, as an array ofPageInfo
objects that are associated with the group - Throws:
ServiceException
- if any system-level error occursNullPointerException
- ifgroupId_
isnull
-
getPagesForGroup
Deprecated.Gets all pages that are associated with the specified group and that the user has permission to view.- Parameters:
groupId_
- the unique Id of the group for which the associated pages should be retrieved- Returns:
- an array of
PageInfo
objects representing the pages that are associated with the group - Throws:
NullPointerException
- if argument isnull
ServiceException
- if any system-level error occurs
-
getPagesForGroups
Deprecated.Gets all pages that are associated with the specified groups and that the user has permission to view.- Parameters:
groupIds_
- the groups for which the associated pages should be retrieved- Returns:
- an array of arrays of
PageInfo
objects, each representing the pages that are associated with the groups in an optimized array. Each row will correspond to the pages of the group with the same index in the parameter. The array will be heterogeneous in that each row will only have as many elements as the group has associated pages. - Throws:
NullPointerException
- if the argument isnull
ServiceException
- if any system-level error occurs
-
getPagesCreatedByUserPaging
ResultPage getPagesCreatedByUserPaging(String username_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, NullPointerException Deprecated.Gets aResultPage
containing those pages created by the specified user that the current user has permission to view.- Parameters:
username_
- the user whose created pages should be retrievedstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the pages, as array ofPageInfo
objects that were created by the given user - Throws:
InvalidUserException
- if specified user does not existNullPointerException
- ifusername_
isnull
ServiceException
- if any system-level error occurs
-
getPagesCreatedByUser
@Deprecated PageInfo[] getPagesCreatedByUser(String username_) throws InvalidUserException, NullPointerException Deprecated.Gets those pages created by the specified user that the current user has permission to view.- Parameters:
username_
- the user whose created pages should be retrieved- Returns:
- an array of
PageInfo
objects representing the pages that were created by the user. - Throws:
InvalidUserException
- if specified user does not existNullPointerException
- ifusername_
isnull
ServiceException
- if any system-level error occurs
-
getPagesCreatedByCurrentUserPaging
ResultPage getPagesCreatedByCurrentUserPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing a list of pages created by the current user- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing list of portal pages as an array ofPageInfo
objects - Throws:
ServiceException
- if any system-level error occurs
-
getPagesCreatedByCurrentUser
Deprecated.Gets a list of pages created by the current user- Returns:
- an array of
PageInfo
representing the portal pages created by the current user - Throws:
ServiceException
- if any system-level error occurs
-
getEditablePagesNotCreatedByCurrentUserPaging
ResultPage getEditablePagesNotCreatedByCurrentUserPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidAnonymousUserException, InvalidUserException Deprecated.Gets a ResultPage containing a list of pages editable by the current user but not created by him- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofPageInfo
objects - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getEditablePagesNotCreatedByCurrentUser
@Deprecated PageInfo[] getEditablePagesNotCreatedByCurrentUser() throws InvalidAnonymousUserException, InvalidUserExceptionDeprecated.Gets a list of pages editable by the current user but not created by him- Returns:
- a list of portal pages
- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getPagesPendingApprovalByCurrentUserPaging
ResultPage getPagesPendingApprovalByCurrentUserPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidAnonymousUserException, InvalidUserException Deprecated.Gets aResultPage
containing a list of pages pending for approval that the current user has permission to approve.- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofPageInfo
objects representing the portal pages pending approval - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getPagesPendingApprovalByCurrentUser
@Deprecated PageInfo[] getPagesPendingApprovalByCurrentUser() throws InvalidAnonymousUserException, InvalidUserExceptionDeprecated.Gets a list of pages pending for approval that the user has permission to approve.- Returns:
- a list of portal pages
- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
findPagesPaging
ResultPage findPagesPaging(String searchTerms_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidAnonymousUserException, InvalidUserException, NullPointerException Deprecated.Searches through names and descriptions of the portal pages the current user can view. The current implementation looks for text containing the search term (case-insensitive).- Parameters:
searchTerms_
- the string to search bystartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the list of pages, as array ofPageInfo
matching the search terms - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursNullPointerException
- ifsearchTerms_
isnull
InvalidAnonymousUserException
-
findPages
@Deprecated PageInfo[] findPages(String searchTerms_) throws InvalidAnonymousUserException, InvalidUserException, NullPointerException Deprecated.Searches through names and descriptions of the portal pages the current user can view. The current implementation looks for text containing the search term (case-insensitive).- Parameters:
searchTerms_
- the string to search by- Returns:
- and array of
PageInfo
objects representing the list of pages matching the search terms - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursNullPointerException
- ifsearchTerms_
isnull
InvalidAnonymousUserException
-
addBookmark
void addBookmark(Long pageId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.Adds the specified page to the current user's bookmarks.- Parameters:
pageId_
- specifies the page that should be added to the bookmarks- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user cannot view the pageInvalidPageException
- if the specified page does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
removeBookmark
void removeBookmark(Long pageId_) throws InvalidAnonymousUserException, InvalidUserException, InvalidPageException Deprecated.Removes the specified page from the current user's bookmarks. If the page is not currently in the bookmarks, simply returns.- Parameters:
pageId_
- specifies the page that should be removed from the bookmarks- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidPageException
- if the specified page does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
removeBookmarks
void removeBookmarks(Long[] pageIds_) throws InvalidAnonymousUserException, InvalidUserException, InvalidPageException, NullPointerException Deprecated.Removes the specified pages from the current user's bookmarks. If the pages are not currently in the bookmarks, simply returns.- Parameters:
pageIds_
- specifies the pages that should be removed from the bookmarks- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidPageException
- if any of the specified pages does not existServiceException
- if any system-level error occursNullPointerException
- if the argument isnull
InvalidAnonymousUserException
-
getBookmarksPaging
ResultPage getBookmarksPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidAnonymousUserException, InvalidUserException Deprecated.Gets aResultPage
containing the list of bookmarked pages for the current user. Anull
is returned for each page that does not exist, or that the user is not authorized to view.- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the list of pages, as an array ofPageInfo
, representing the current user's bookmarks - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getBookmarks
Deprecated.Gets the list of bookmarked pages for the current user. Anull
is returned for each page that does not exist, or that the user is not authorized to view.- Returns:
- the list of pages in the current user's bookmarks
- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getCategoryDescendants
TreePivot getCategoryDescendants(Long categoryId_, int levels_) throws InvalidAnonymousUserException, InvalidUserException, InvalidCategoryException Deprecated.Gets the descendants of a category up to the specified depth. To start at top, pass inCATEGORY_TOP
for categoryId. Each node in the subtree and breadcrumbs retrieved from the returnedTreePivot
will be populated withid
(the ID of the category) andname
(the name of the category). Thedata
field of the node is not populated.- Parameters:
categoryId_
- the categorylevels_
- the depths of the tree to return- Returns:
- a category Tree rooted at
categoryId_
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidCategoryException
- if the specified category does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
getRootCategories
Deprecated.Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category). Thedata
field of the node is not populated.- Parameters:
levels_
- the number of levels of children to get. This value must be greater than or equal to 0.- Returns:
- a list of
Tree
objects representing the root categories - Throws:
ServiceException
- if any system-level error occurs
-
getRootCategoriesPaging
ResultPage getRootCategoriesPaging(int levels_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category). Thedata
field of the node is not populated.- Parameters:
levels_
- the number of levels of children to get. This value must be greater than or equal to 0.startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inTree
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing at
Tree
objects representing the root categories - Throws:
ServiceException
- if any system-level error occurs
-
getCategoriesPageCounts
Deprecated.Gets the number of pages in each category, for a list of categories- Parameters:
categoryIds_
- the Ids of the categories- Returns:
- a list of the number of pages for each category. If a
category Id does not correspond to a valid category,
null
will be returned for that category - Throws:
ServiceException
- if any system-level error occurs
-
getAllCategoriesPaging
ResultPage getAllCategoriesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets aResultPage
containing all categories Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category). Thedata
field of the node is not populated.- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inTree
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
ofTree
objects - Throws:
ServiceException
- if any system-level error occurs
-
getAllCategories
Deprecated.Gets all categories. Each node in the returned trees (and their breadcrumbs) will be populated withid
(the ID of the category) andname
(the name of the category). Thedata
field of the node is not populated.- Returns:
- an array of
Tree
s representing all the categories - Throws:
ServiceException
- if any system-level error occurs
-
getPagesInCategoryPaging
ResultPage getPagesInCategoryPaging(Long categoryId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCategoryException Deprecated.Gets a ResultPage containing all the pages that are in a specified category, and that the current user has permission to view. Passnull
to return all pages in all categories that the current user has permission to view.- Parameters:
categoryId_
- the category idstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.sortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofPageInfo
objects, representing the pages in the given category - Throws:
InvalidCategoryException
- if category id is notnull
, and does not correspond to a valid categoryServiceException
- if any system-level error occurs
-
getPagesInCategory
Deprecated.Gets all the pages that are in a specified category, and that the current user has permission to view. Passnull
to return all pages in all categories that the current user has permission to view.- Parameters:
categoryId_
- the category id- Returns:
- a list of pages of the given category
- Throws:
InvalidCategoryException
- if category id is notnull
, and does not correspond to a valid categoryServiceException
- if any system-level error occurs
-
addCategory
Long addCategory(String name_, Long parentCategoryId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidCategoryException Deprecated.Add a category. If this category should be a root category (have no parent), pass inCATEGORY_TOP
for parentId.- Parameters:
name_
- the name of the categoryparentCategoryId_
- the id of its parent- Returns:
- the id of the newly added category
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user is not a portal administratorInvalidCategoryException
- if the parentId is notCATEGORY_TOP
and this category does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
removeCategory
void removeCategory(Long categoryId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidOperationException, InvalidCategoryException, NotEmptyException Deprecated.Remove a category. If a category is removed which has pages in it, the pages will no longer belong to any category.- Parameters:
categoryId_
- the id of the category to be removed- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidOperationException
- if the category has descendants. To delete the catgory and its descendants, useremoveCategoryAndDescendants(java.lang.Long)
insteadPrivilegeException
- if the current user is not a portal administratorInvalidCategoryException
- if the specified category does not existNotEmptyException
- if the specified category is not emptyServiceException
- if any system-level error occursInvalidAnonymousUserException
- See Also:
-
removeCategoryAndDescendants
void removeCategoryAndDescendants(Long categoryId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidCategoryException Deprecated.Remove a category and all of its descendants. If any category is removed which has pages in it, the pages will no longer belong to any category.- Parameters:
categoryId_
- the id of the category to be removed- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user is not a portal administratorInvalidCategoryException
- if the specified category does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
setGroupAssociationForPage
void setGroupAssociationForPage(Long pageId_, Long groupId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.Associates a page to a group and a group to a page for the page and the group specified. The page will be updated to belong to that group. Only page creators/administrators who are also administrators of the group, or portal administrators can successfully call this method. NOTE: Any group previously associated with the page will still have access to it. Passingnull
forgroupId_
dissociates the group from the page specified (that it was originally associated with), and also the page from that group.- Parameters:
pageId_
- the id of the pagegroupId_
- the id of the group. Set to null to delete the reference.- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the user does not have sufficient privileges to perform this actionInvalidPageException
- if the page does not existServiceException
- if any system-level error occursInvalidAnonymousUserException
-
setHomePageForAnonymous
@Deprecated void setHomePageForAnonymous(Long pageId_) throws InvalidAnonymousUserException, InvalidUserException, PrivilegeException, InvalidPageException Deprecated.anonymous user access was removed in 6.2Sets the home page for anonymous users.- Parameters:
pageId_
- the unique Id of the page to be set as the home page for anonymous users- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidPageException
- if the specified page does not existPrivilegeException
- if the current user is not an administrator of the specified groupServiceException
- if any system-level error occursInvalidAnonymousUserException
-
renameCategory
@Deprecated void renameCategory(Long pCategoryId_, String pCategoryName_) throws PrivilegeException, InvalidUserException, InvalidCategoryException, InvalidAnonymousUserException Deprecated.Renames the page category specified bypCategoryId_
to the newpCategoryName_
- Parameters:
pCategoryId_
- Id of the page category to be renamed.pCategoryName_
- new name for the page category.- Throws:
PrivilegeException
- if the user does not have sufficient privileges to perform this actionInvalidUserException
- if the user calling this method is invalidInvalidCategoryException
- if the specified category does not existInvalidAnonymousUserException
-
getLoginData
LoginData getLoginData(int bookmarkPagingStartIndex_, int bookmarkPagingBatchSize_, Integer bookmarkPagingSortProperty_, Integer bookmarkPagingSortOrder_) throws InvalidAnonymousUserException, InvalidUserException Deprecated.Gets aLoginData
bean containing the list of bookmarked pages for the current user, as well as a flag representing whether the user, or any of his member groups, references an invalid page. Anull
is returned for each bookmarked page that does not exist, or that the user is not authorized to view.- Parameters:
bookmarkPagingStartIndex_
- the index into the collection of total bookmarks at which to start. Negative numbers are treated as zeros.bookmarkPagingBatchSize_
- the number of bookmarks to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.bookmarkPagingSortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPageInfo
.bookmarkPagingSortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
LoginData
containing the list of pages as the_bookmarks
field, as an array ofPageInfo
, representing the current user's bookmarks - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-
cleanUpPageReferences
Deprecated.Deletes any references to invalid pages for that user or his member groups. References addressed include the user's bookmarks, tabs and home page, and the pages and home page of the groups.- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursInvalidAnonymousUserException
-