com.appiancorp.suiteapi.portal

Interface PageNavigationService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

Deprecated.

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

@Deprecated
public interface PageNavigationService
extends com.appiancorp.services.ContextSensitiveService

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 inside PageInfo
• 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) then PageInfo.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.

See Also:

AdministrationService, NotificationService, PageService, PortalNotificationService, PortalSearchService, PortletService

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	addBookmark$UPDATES Deprecated.
static boolean	addCategory$UPDATES Deprecated.
static java.lang.Long	CATEGORY_TOP Deprecated. A constant used to indicated that sorting hierarchical tree structures of portal pages starts at the top.
static boolean	cleanUpPageReferences$UPDATES Deprecated.
static boolean	findPages$UPDATES Deprecated.
static boolean	findPagesPaging$UPDATES Deprecated.
static boolean	getAllCategories$UPDATES Deprecated.
static boolean	getAllCategoriesPaging$UPDATES Deprecated.
static boolean	getBookmarks$UPDATES Deprecated.
static boolean	getBookmarksPaging$UPDATES Deprecated.
static boolean	getCategoriesPageCounts$UPDATES Deprecated.
static boolean	getCategoryDescendants$UPDATES Deprecated.
static boolean	getEditablePagesNotCreatedByCurrentUser$UPDATES Deprecated.
static boolean	getEditablePagesNotCreatedByCurrentUserPaging$UPDATES Deprecated.
static boolean	getHomePage$UPDATES Deprecated.
static boolean	getHomePageForGroup$UPDATES Deprecated.
static boolean	getHomePagesForGroups$UPDATES Deprecated.
static boolean	getHomePagesForGroupsPaging$UPDATES Deprecated.
static boolean	getLoginData$UPDATES Deprecated.
static boolean	getPagesCreatedByCurrentUser$UPDATES Deprecated.
static boolean	getPagesCreatedByCurrentUserPaging$UPDATES Deprecated.
static boolean	getPagesCreatedByUser$UPDATES Deprecated.
static boolean	getPagesCreatedByUserPaging$UPDATES Deprecated.
static boolean	getPagesForGroup$UPDATES Deprecated.
static boolean	getPagesForGroupPaging$UPDATES Deprecated.
static boolean	getPagesForGroups$UPDATES Deprecated.
static boolean	getPagesInCategory$UPDATES Deprecated.
static boolean	getPagesInCategoryPaging$UPDATES Deprecated.
static boolean	getPagesPendingApprovalByCurrentUser$UPDATES Deprecated.
static boolean	getPagesPendingApprovalByCurrentUserPaging$UPDATES Deprecated.
static boolean	getRootCategories$UPDATES Deprecated.
static boolean	getRootCategoriesPaging$UPDATES Deprecated.
static boolean	getVisiblePagesForGroups$UPDATES Deprecated.
static boolean	removeBookmark$UPDATES Deprecated.
static boolean	removeBookmarks$UPDATES Deprecated.
static boolean	removeCategory$UPDATES Deprecated.
static boolean	removeCategoryAndDescendants$UPDATES Deprecated.
static boolean	renameCategory$UPDATES Deprecated.
static boolean	setGroupAssociationForPage$UPDATES Deprecated.
static boolean	setHomePage$UPDATES Deprecated.
static boolean	setHomePageForAnonymous$UPDATES Deprecated.
static boolean	setHomePageForGroup$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
void	addBookmark(java.lang.Long pageId_) Deprecated. Adds the specified page to the current user's bookmarks.
java.lang.Long	addCategory(java.lang.String name_, java.lang.Long parentCategoryId_) Deprecated. Add a category.
void	cleanUpPageReferences() Deprecated. Deletes any references to invalid pages for that user or his member groups.
PageInfo[]	findPages(java.lang.String searchTerms_) Deprecated. use findPagesPaging(java.lang.String, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	findPagesPaging(java.lang.String searchTerms_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Searches through names and descriptions of the portal pages the current user can view.
Tree[]	getAllCategories() Deprecated. use getAllCategoriesPaging(int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getAllCategoriesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing all categories Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category).
PageInfo[]	getBookmarks() Deprecated. use getBookmarksPaging(int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getBookmarksPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing the list of bookmarked pages for the current user.
java.lang.Long[]	getCategoriesPageCounts(java.lang.Long[] categoryIds_) Deprecated. Gets the number of pages in each category, for a list of categories
TreePivot	getCategoryDescendants(java.lang.Long categoryId_, int levels_) Deprecated. Gets the descendants of a category up to the specified depth.
PageInfo[]	getEditablePagesNotCreatedByCurrentUser() Deprecated. use getEditablePagesNotCreatedByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer)
ResultPage	getEditablePagesNotCreatedByCurrentUserPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing a list of pages editable by the current user but not created by him
PageInfo	getHomePage() Deprecated. Gets the home page for the current user.
PageInfo	getHomePageForGroup(java.lang.Long groupId_) Deprecated. Gets the home page of the specified group.
PageInfo[]	getHomePagesForGroups(java.lang.Long[] groupIds_) Deprecated. use getHomePagesForGroupsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getHomePagesForGroupsPaging(java.lang.Long[] groupIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing the home pages of the specified groups.
LoginData	getLoginData(int bookmarkPagingStartIndex_, int bookmarkPagingBatchSize_, java.lang.Integer bookmarkPagingSortProperty_, java.lang.Integer bookmarkPagingSortOrder_) Deprecated. Gets a LoginData 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[]	getPagesCreatedByCurrentUser() Deprecated. use getPagesCreatedByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getPagesCreatedByCurrentUserPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing a list of pages created by the current user
PageInfo[]	getPagesCreatedByUser(java.lang.String username_) Deprecated. use getPagesCreatedByUserPaging(java.lang.String, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getPagesCreatedByUserPaging(java.lang.String username_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing those pages created by the specified user that the current user has permission to view.
PageInfo[]	getPagesForGroup(java.lang.Long groupId_) Deprecated. use getPagesForGroupPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getPagesForGroupPaging(java.lang.Long groupId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing all pages that are associated with the specified group and that the user has permission to view.
PageInfo[][]	getPagesForGroups(java.lang.Long[] groupIds_) Deprecated. Gets all pages that are associated with the specified groups and that the user has permission to view.
PageInfo[]	getPagesInCategory(java.lang.Long categoryId_) Deprecated. use getPagesInCategoryPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getPagesInCategoryPaging(java.lang.Long categoryId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.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[]	getPagesPendingApprovalByCurrentUser() Deprecated. use getPagesPendingApprovalByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getPagesPendingApprovalByCurrentUserPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a ResultPage containing a list of pages pending for approval that the current user has permission to approve.
Tree[]	getRootCategories(int levels_) Deprecated. use getRootCategoriesPaging(int, int, int, java.lang.Integer, java.lang.Integer) instead
ResultPage	getRootCategoriesPaging(int levels_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category).
java.lang.Boolean[]	getVisiblePagesForGroups(java.lang.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(java.lang.Long pageId_) Deprecated. Removes the specified page from the current user's bookmarks.
void	removeBookmarks(java.lang.Long[] pageIds_) Deprecated. Removes the specified pages from the current user's bookmarks.
void	removeCategory(java.lang.Long categoryId_) Deprecated. Remove a category.
void	removeCategoryAndDescendants(java.lang.Long categoryId_) Deprecated. Remove a category and all of its descendants.
void	renameCategory(java.lang.Long pCategoryId_, java.lang.String pCategoryName_) Deprecated. use addCategory(java.lang.String, java.lang.Long) and removeCategory(java.lang.Long) instead
void	setGroupAssociationForPage(java.lang.Long pageId_, java.lang.Long groupId_) Deprecated. Associates a page to a group and a group to a page for the page and the group specified.
void	setHomePage(java.lang.Long pageId_) Deprecated. Sets the home page for the current user.
void	setHomePageForAnonymous(java.lang.Long pageId_) Deprecated. anonymous user access was removed in 6.2
void	setHomePageForGroup(java.lang.Long pageId_, java.lang.Long groupId_) Deprecated. Sets the home page for the specified group.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

CATEGORY_TOP

static final java.lang.Long CATEGORY_TOP

Deprecated.

A constant used to indicated that sorting hierarchical tree structures of portal pages starts at the top. See getCategoryDescendants(Long, int) for an example.

setHomePage$UPDATES

static final boolean setHomePage$UPDATES

Deprecated.

See Also:

Constant Field Values

setHomePageForGroup$UPDATES

static final boolean setHomePageForGroup$UPDATES

Deprecated.

See Also:

Constant Field Values

getHomePage$UPDATES

static final boolean getHomePage$UPDATES

Deprecated.

See Also:

Constant Field Values

getHomePageForGroup$UPDATES

static final boolean getHomePageForGroup$UPDATES

Deprecated.

See Also:

Constant Field Values

getHomePagesForGroupsPaging$UPDATES

static final boolean getHomePagesForGroupsPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getHomePagesForGroups$UPDATES

static final boolean getHomePagesForGroups$UPDATES

Deprecated.

See Also:

Constant Field Values

getVisiblePagesForGroups$UPDATES

static final boolean getVisiblePagesForGroups$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesForGroupPaging$UPDATES

static final boolean getPagesForGroupPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesForGroup$UPDATES

static final boolean getPagesForGroup$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesForGroups$UPDATES

static final boolean getPagesForGroups$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesCreatedByUserPaging$UPDATES

static final boolean getPagesCreatedByUserPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesCreatedByUser$UPDATES

static final boolean getPagesCreatedByUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesCreatedByCurrentUserPaging$UPDATES

static final boolean getPagesCreatedByCurrentUserPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesCreatedByCurrentUser$UPDATES

static final boolean getPagesCreatedByCurrentUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getEditablePagesNotCreatedByCurrentUserPaging$UPDATES

static final boolean getEditablePagesNotCreatedByCurrentUserPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getEditablePagesNotCreatedByCurrentUser$UPDATES

static final boolean getEditablePagesNotCreatedByCurrentUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesPendingApprovalByCurrentUserPaging$UPDATES

static final boolean getPagesPendingApprovalByCurrentUserPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesPendingApprovalByCurrentUser$UPDATES

static final boolean getPagesPendingApprovalByCurrentUser$UPDATES

Deprecated.

See Also:

Constant Field Values

findPagesPaging$UPDATES

static final boolean findPagesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

findPages$UPDATES

static final boolean findPages$UPDATES

Deprecated.

See Also:

Constant Field Values

addBookmark$UPDATES

static final boolean addBookmark$UPDATES

Deprecated.

See Also:

Constant Field Values

removeBookmark$UPDATES

static final boolean removeBookmark$UPDATES

Deprecated.

See Also:

Constant Field Values

removeBookmarks$UPDATES

static final boolean removeBookmarks$UPDATES

Deprecated.

See Also:

Constant Field Values

getBookmarksPaging$UPDATES

static final boolean getBookmarksPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getBookmarks$UPDATES

static final boolean getBookmarks$UPDATES

Deprecated.

See Also:

Constant Field Values

getCategoryDescendants$UPDATES

static final boolean getCategoryDescendants$UPDATES

Deprecated.

See Also:

Constant Field Values

getRootCategories$UPDATES

static final boolean getRootCategories$UPDATES

Deprecated.

See Also:

Constant Field Values

getRootCategoriesPaging$UPDATES

static final boolean getRootCategoriesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getCategoriesPageCounts$UPDATES

static final boolean getCategoriesPageCounts$UPDATES

Deprecated.

See Also:

Constant Field Values

getAllCategoriesPaging$UPDATES

static final boolean getAllCategoriesPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getAllCategories$UPDATES

static final boolean getAllCategories$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesInCategoryPaging$UPDATES

static final boolean getPagesInCategoryPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getPagesInCategory$UPDATES

static final boolean getPagesInCategory$UPDATES

Deprecated.

See Also:

Constant Field Values

addCategory$UPDATES

static final boolean addCategory$UPDATES

Deprecated.

See Also:

Constant Field Values

removeCategory$UPDATES

static final boolean removeCategory$UPDATES

Deprecated.

See Also:

Constant Field Values

removeCategoryAndDescendants$UPDATES

static final boolean removeCategoryAndDescendants$UPDATES

Deprecated.

See Also:

Constant Field Values

setGroupAssociationForPage$UPDATES

static final boolean setGroupAssociationForPage$UPDATES

Deprecated.

See Also:

Constant Field Values

setHomePageForAnonymous$UPDATES

static final boolean setHomePageForAnonymous$UPDATES

Deprecated.

See Also:

Constant Field Values

renameCategory$UPDATES

static final boolean renameCategory$UPDATES

Deprecated.

See Also:

Constant Field Values

getLoginData$UPDATES

static final boolean getLoginData$UPDATES

Deprecated.

See Also:

Constant Field Values

cleanUpPageReferences$UPDATES

static final boolean cleanUpPageReferences$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

setHomePage

void setHomePage(java.lang.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 invalid

PrivilegeException - if the current user is not authorized to view the page

InvalidPageException - if the specified page does not exist

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if the pageId_ is null

InvalidAnonymousUserException

setHomePageForGroup

void setHomePageForGroup(java.lang.Long pageId_,
                         java.lang.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 group

groupId_ - the unique Id of the specified group

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - 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 exist

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if any argument is null

InvalidAnonymousUserException

getHomePage

PageInfo getHomePage()
              throws PrivilegeException,
                     InvalidAnonymousUserException,
                     InvalidUserException,
                     InvalidPageException

Deprecated.

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 an InvalidPageException 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 page

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if both the explicitly set home page and the default home page are not available, that is, the pages have since been deleted

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getHomePageForGroup

PageInfo getHomePageForGroup(java.lang.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. Returns null if there are no pages associated with the group.

Throws:

InvalidAnonymousUserException - never thrown (known issue)

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the user does not have sufficient privileges to view the page

java.lang.NullPointerException - if the argument is null

InvalidPageException - if the page associated with the group no longer exists

ServiceException - if any system-level error occurs

getHomePagesForGroupsPaging

ResultPage getHomePagesForGroupsPaging(java.lang.Long[] groupIds_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidPageException

Deprecated.

Gets a ResultPage containing the home pages of the specified groups.

Parameters:

groupIds_ - the groups for which the home page should be retrieved

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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing the home pages as an array of PageInfo 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). The ResultPage 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 deleted

java.lang.NullPointerException - if the passed groupIds_ array or any of its elements is null

ServiceException - if any system-level error occurs

getHomePagesForGroups

@Deprecated
PageInfo[] getHomePagesForGroups(java.lang.Long[] groupIds_)
                                      throws InvalidPageException,
                                             java.lang.NullPointerException,
                                             InvalidUserException

Deprecated. use getHomePagesForGroupsPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer) instead

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. A null 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 then null items will be set.

Throws:

InvalidPageException - if any of the specified pages does not exist, that is, if any associated page has since been deleted

java.lang.NullPointerException - if the argument is null

InvalidUserException - if the context of the user who made the call is invalid

ServiceException - if any system-level error occurs

getVisiblePagesForGroups

java.lang.Boolean[] getVisiblePagesForGroups(java.lang.Long[] groupIds_)
                                      throws java.lang.NullPointerException

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 returns false 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:

java.lang.NullPointerException - if the argument is null

ServiceException - if any system-level error occurs

getPagesForGroupPaging

ResultPage getPagesForGroupPaging(java.lang.Long groupId_,
                                  int startIndex_,
                                  int batchSize_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.Integer sortOrder_)
                           throws java.lang.NullPointerException

Deprecated.

Gets a ResultPage 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 retrieved

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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing the pages, as an array of PageInfo objects that are associated with the group

Throws:

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if groupId_ is null

getPagesForGroup

@Deprecated
PageInfo[] getPagesForGroup(java.lang.Long groupId_)
                                 throws java.lang.NullPointerException

Deprecated. use getPagesForGroupPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead

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:

java.lang.NullPointerException - if argument is null

ServiceException - if any system-level error occurs

getPagesForGroups

PageInfo[][] getPagesForGroups(java.lang.Long[] groupIds_)
                        throws java.lang.NullPointerException

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:

java.lang.NullPointerException - if the argument is null

ServiceException - if any system-level error occurs

getPagesCreatedByUserPaging

ResultPage getPagesCreatedByUserPaging(java.lang.String username_,
                                       int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidUserException,
                                       java.lang.NullPointerException

Deprecated.

Gets a ResultPage 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 retrieved

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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing the pages, as array of PageInfo objects that were created by the given user

Throws:

InvalidUserException - if specified user does not exist

java.lang.NullPointerException - if username_ is null

ServiceException - if any system-level error occurs

getPagesCreatedByUser

@Deprecated
PageInfo[] getPagesCreatedByUser(java.lang.String username_)
                                      throws InvalidUserException,
                                             java.lang.NullPointerException

Deprecated. use getPagesCreatedByUserPaging(java.lang.String, int, int, java.lang.Integer, java.lang.Integer) instead

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 exist

java.lang.NullPointerException - if username_ is null

ServiceException - if any system-level error occurs

getPagesCreatedByCurrentUserPaging

ResultPage getPagesCreatedByCurrentUserPaging(int startIndex_,
                                              int batchSize_,
                                              java.lang.Integer sortProperty_,
                                              java.lang.Integer sortOrder_)

Deprecated.

Gets a ResultPage 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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing list of portal pages as an array of PageInfo objects

Throws:

ServiceException - if any system-level error occurs

getPagesCreatedByCurrentUser

@Deprecated
PageInfo[] getPagesCreatedByCurrentUser()

Deprecated. use getPagesCreatedByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead

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_,
                                                         java.lang.Integer sortProperty_,
                                                         java.lang.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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of PageInfo objects

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getEditablePagesNotCreatedByCurrentUser

@Deprecated
PageInfo[] getEditablePagesNotCreatedByCurrentUser()
                                                        throws InvalidAnonymousUserException,
                                                               InvalidUserException

Deprecated. use getEditablePagesNotCreatedByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer)

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 invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getPagesPendingApprovalByCurrentUserPaging

ResultPage getPagesPendingApprovalByCurrentUserPaging(int startIndex_,
                                                      int batchSize_,
                                                      java.lang.Integer sortProperty_,
                                                      java.lang.Integer sortOrder_)
                                               throws InvalidAnonymousUserException,
                                                      InvalidUserException

Deprecated.

Gets a ResultPage 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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of PageInfo objects representing the portal pages pending approval

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getPagesPendingApprovalByCurrentUser

@Deprecated
PageInfo[] getPagesPendingApprovalByCurrentUser()
                                                     throws InvalidAnonymousUserException,
                                                            InvalidUserException

Deprecated. use getPagesPendingApprovalByCurrentUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead

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 invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

findPagesPaging

ResultPage findPagesPaging(java.lang.String searchTerms_,
                           int startIndex_,
                           int batchSize_,
                           java.lang.Integer sortProperty_,
                           java.lang.Integer sortOrder_)
                    throws InvalidAnonymousUserException,
                           InvalidUserException,
                           java.lang.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

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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing the list of pages, as array of PageInfo matching the search terms

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if searchTerms_ is null

InvalidAnonymousUserException

findPages

@Deprecated
PageInfo[] findPages(java.lang.String searchTerms_)
                          throws InvalidAnonymousUserException,
                                 InvalidUserException,
                                 java.lang.NullPointerException

Deprecated. use findPagesPaging(java.lang.String, int, int, java.lang.Integer, java.lang.Integer) instead

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 invalid

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if searchTerms_ is null

InvalidAnonymousUserException

addBookmark

void addBookmark(java.lang.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 invalid

PrivilegeException - if the current user cannot view the page

InvalidPageException - if the specified page does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

removeBookmark

void removeBookmark(java.lang.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 invalid

InvalidPageException - if the specified page does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

removeBookmarks

void removeBookmarks(java.lang.Long[] pageIds_)
              throws InvalidAnonymousUserException,
                     InvalidUserException,
                     InvalidPageException,
                     java.lang.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 invalid

InvalidPageException - if any of the specified pages does not exist

ServiceException - if any system-level error occurs

java.lang.NullPointerException - if the argument is null

InvalidAnonymousUserException

getBookmarksPaging

ResultPage getBookmarksPaging(int startIndex_,
                              int batchSize_,
                              java.lang.Integer sortProperty_,
                              java.lang.Integer sortOrder_)
                       throws InvalidAnonymousUserException,
                              InvalidUserException

Deprecated.

Gets a ResultPage containing the list of bookmarked pages for the current user. A null 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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing the list of pages, as an array of PageInfo, representing the current user's bookmarks

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getBookmarks

@Deprecated
PageInfo[] getBookmarks()
                             throws InvalidAnonymousUserException,
                                    InvalidUserException

Deprecated. use getBookmarksPaging(int, int, java.lang.Integer, java.lang.Integer) instead

Gets the list of bookmarked pages for the current user. A null 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 invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getCategoryDescendants

TreePivot getCategoryDescendants(java.lang.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 in CATEGORY_TOP for categoryId. Each node in the subtree and breadcrumbs retrieved from the returned TreePivot will be populated with id (the ID of the category) and name (the name of the category). The data field of the node is not populated.

Parameters:

categoryId_ - the category

levels_ - the depths of the tree to return

Returns:

a category Tree rooted at categoryId_

Throws:

InvalidUserException - if the user calling this method is invalid

InvalidCategoryException - if the specified category does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

getRootCategories

@Deprecated
Tree[] getRootCategories(int levels_)

Deprecated. use getRootCategoriesPaging(int, int, int, java.lang.Integer, java.lang.Integer) instead

Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category). The data 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_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.Integer sortOrder_)

Deprecated.

Gets the root categories Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category). The data 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. Use Constants.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 the SORT_BY_XXX constants in Tree.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing at Tree objects representing the root categories

Throws:

ServiceException - if any system-level error occurs

getCategoriesPageCounts

java.lang.Long[] getCategoriesPageCounts(java.lang.Long[] categoryIds_)

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_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.Integer sortOrder_)

Deprecated.

Gets a ResultPage containing all categories Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category). The data 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. Use Constants.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 the SORT_BY_XXX constants in Tree.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage of Tree objects

Throws:

ServiceException - if any system-level error occurs

getAllCategories

@Deprecated
Tree[] getAllCategories()

Deprecated. use getAllCategoriesPaging(int, int, java.lang.Integer, java.lang.Integer) instead

Gets all categories. Each node in the returned trees (and their breadcrumbs) will be populated with id (the ID of the category) and name (the name of the category). The data field of the node is not populated.

Returns:

an array of Trees representing all the categories

Throws:

ServiceException - if any system-level error occurs

getPagesInCategoryPaging

ResultPage getPagesInCategoryPaging(java.lang.Long categoryId_,
                                    int startIndex_,
                                    int batchSize_,
                                    java.lang.Integer sortProperty_,
                                    java.lang.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. Pass null to return all pages in all categories that the current user has permission to view.

Parameters:

categoryId_ - the category id

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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of PageInfo objects, representing the pages in the given category

Throws:

InvalidCategoryException - if category id is not null, and does not correspond to a valid category

ServiceException - if any system-level error occurs

getPagesInCategory

@Deprecated
PageInfo[] getPagesInCategory(java.lang.Long categoryId_)
                                   throws InvalidCategoryException

Deprecated. use getPagesInCategoryPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead

Gets all the pages that are in a specified category, and that the current user has permission to view. Pass null 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 not null, and does not correspond to a valid category

ServiceException - if any system-level error occurs

addCategory

java.lang.Long addCategory(java.lang.String name_,
                           java.lang.Long parentCategoryId_)
                    throws InvalidAnonymousUserException,
                           InvalidUserException,
                           PrivilegeException,
                           InvalidCategoryException

Deprecated.

Add a category. If this category should be a root category (have no parent), pass in CATEGORY_TOP for parentId.

Parameters:

name_ - the name of the category

parentCategoryId_ - the id of its parent

Returns:

the id of the newly added category

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not a portal administrator

InvalidCategoryException - if the parentId is not CATEGORY_TOP and this category does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

removeCategory

void removeCategory(java.lang.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 invalid

InvalidOperationException - if the category has descendants. To delete the catgory and its descendants, use removeCategoryAndDescendants(java.lang.Long) instead

PrivilegeException - if the current user is not a portal administrator

InvalidCategoryException - if the specified category does not exist

NotEmptyException - if the specified category is not empty

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

See Also:

removeCategoryAndDescendants(Long)

removeCategoryAndDescendants

void removeCategoryAndDescendants(java.lang.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 invalid

PrivilegeException - if the current user is not a portal administrator

InvalidCategoryException - if the specified category does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

setGroupAssociationForPage

void setGroupAssociationForPage(java.lang.Long pageId_,
                                java.lang.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. Passing null for groupId_ 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 page

groupId_ - the id of the group. Set to null to delete the reference.

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the user does not have sufficient privileges to perform this action

InvalidPageException - if the page does not exist

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

setHomePageForAnonymous

@Deprecated
void setHomePageForAnonymous(java.lang.Long pageId_)
                                  throws InvalidAnonymousUserException,
                                         InvalidUserException,
                                         PrivilegeException,
                                         InvalidPageException

Deprecated. anonymous user access was removed in 6.2

Sets 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 invalid

InvalidPageException - if the specified page does not exist

PrivilegeException - if the current user is not an administrator of the specified group

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

renameCategory

@Deprecated
void renameCategory(java.lang.Long pCategoryId_,
                                java.lang.String pCategoryName_)
                         throws PrivilegeException,
                                InvalidUserException,
                                InvalidCategoryException,
                                InvalidAnonymousUserException

Deprecated. use addCategory(java.lang.String, java.lang.Long) and removeCategory(java.lang.Long) instead

Renames the page category specified by pCategoryId_ to the new pCategoryName_

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 action

InvalidUserException - if the user calling this method is invalid

InvalidCategoryException - if the specified category does not exist

InvalidAnonymousUserException

getLoginData

LoginData getLoginData(int bookmarkPagingStartIndex_,
                       int bookmarkPagingBatchSize_,
                       java.lang.Integer bookmarkPagingSortProperty_,
                       java.lang.Integer bookmarkPagingSortOrder_)
                throws InvalidAnonymousUserException,
                       InvalidUserException

Deprecated.

Gets a LoginData 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. A null 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. Use Constants.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 the SORT_BY_XXX constants in PageInfo.

bookmarkPagingSortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a LoginData containing the list of pages as the _bookmarks field, as an array of PageInfo, representing the current user's bookmarks

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException

cleanUpPageReferences

void cleanUpPageReferences()
                    throws InvalidAnonymousUserException,
                           InvalidUserException

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 invalid

ServiceException - if any system-level error occurs

InvalidAnonymousUserException