Package com.appiancorp.suiteapi.portal

Interface PageService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

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

Deprecated.

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

Defines methods for access and modification of pages. There are two kinds of pages: portal pages are pages that contain portlets (all information must be displayed through portlets); custom pages are custom-made external JSP/HTML pages. All pages can be associated with categories for searching/browsing. A page can also be associated with a group (Department/Team) in which case it will be listed in the main left navigation bar under the group name if the user has sufficient privileges for viewing the page.

Portal pages have a "zone count" attribute which specifies the number of zones the page has for placing portlets. The portlets contained in a portal page can be Deactivated or Deleted; deactivating a portlet just hides it from the page, while deleting a portlet removes it permanently along with all its content (for shared portlets, all instances of the portlet on other pages will also be removed).

Pages can be private or public. The security for private pages is defined as follows:

• a Portal Administrator can Delete, Edit, Approve, View, Target, Rename, Change Template, and Categorize the page (all the possible opertions)
• a Page Creator can Delete, Edit, View, Target, Rename, Change Template, and Categorize the page (same as Portal Administrator, but can't Approve)
• a Page Administrator can Delete, Edit, View, Target, Rename, Change Template, and Categorize the page (same as Page Creator)
• a Page Editor can View and Edit the page
• a Page Approver can View and Approve the page
• a Page Viewer can View the page
• an Anonymous User or Basic User with no explicit privileges (such as Page Admin/Editor/Approver/Viewer) cannot perform any operations

For public pages, the security is the same, except that everyone is allowed to view the page (including Anonymous and Basic Users). Personal and Department/Team pages are defined as private.

Portlets within portal pages have an additional separate security map defined as follows:

• a Portal Administrator, Portlet Creator, or Portlet Administrator can Delete, Edit, View, Rename, Change Container, and Target the portlet (all the possible opertions)
• a Portlet Editor can View and Edit the portlet
• a Portlet Viewer can View the portlet
• an Anonymous User or Basic User with no explicit privileges (such as Portlet Admin/Editor/Approver/Viewer) cannot perform any operations

When a user edits a page, the page is locked and a draft is created. Unless a user has the privileges to break the lock on the page, he/she will not be able to edit the page. If the page options are set such that modifications to the page require approval, the draft first has to be approved at which point it is published. Once a draft is published, it will be visible to page viewers.

Contributions are a way to log and keep track of all the content additions made by users. When a user submits new/updated content, or removes content, addContribution(com.appiancorp.suiteapi.portal.Contribution)/updateContribution(com.appiancorp.suiteapi.portal.Contribution) or deleteContribution(com.appiancorp.suiteapi.portal.Contribution) should be called to log the event. This should be done for modifications of all content (not just pages but all Appian Type objects such as forums, documents, etc). The getContributionsForTypePaging(com.appiancorp.suiteapi.portal.Contribution, int, int, java.lang.Integer, java.lang.Integer) method can then be used later to retrieve the logged user content modifications.

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()).

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:

• Page
• PageInfo
• PageRoleMap
• PageNavigationService
• Contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	addContribution$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	addPortlet$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	addPortlets$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	approveDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	changePageDescription$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	changePageTemplate$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	createPage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	createPages$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final Integer	DEACTIVATE_PORTLET	Deprecated. A constant representing the deactivation of a portlet
static final Integer	DELETE_PORTLET	Deprecated. A constant representing the deletion of a portlet
static final boolean	deleteContribution$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	deleteDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	deletePage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getAccessLevelForPage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getAccessLevelForPages$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getContributions$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getContributionsForType$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getContributionsForTypePaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getMaximumContributions$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPages$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPagesList$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getPagesPaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getRoleMapForPage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	movePortlet$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	peekDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	publishDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	publishDrafts$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	removePortlet$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	renamePage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	returnDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setIsPagePublic$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setMaximumContributions$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setPageApproval$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setPageCategory$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setPageDataContextType$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setPageUrl$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setRoleMapForPage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	takeDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	unlockDraft$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updateContribution$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updatePage$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updatePages$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	validateTypedValues$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
void	addContribution(Contribution contribution_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
void	addPortlet(Long pageId_, Long portletId_, Integer zone_, int index_)	Deprecated. Attempts to lock the current draft of the specified page and add a portlet.
void	addPortlets(Long pageId_, Long[] portletIds_, Integer[] zones_, int[] indices_)	Deprecated. Attempts to lock the current draft of the specified page and add portlets.
void	approveDraft(Long pageId_)	Deprecated. Applies the changes made to the draft of the specified page, and clears the draft.
void	changePageDescription(Long pageId_, String newDescription_)	Deprecated. Changes the description of the specified page.
void	changePageTemplate(Long pageId_, String newTemplateName_, int newZoneCount_)	Deprecated. Attempts to lock the current draft for the specified page (i.e., put the page into draft state) and changes the template in the draft.
Long	createPage(Page page_)	Deprecated. Creates a page using the attributes specified in the passed object.
Long[]	createPages(Page[] pages_)	Deprecated. Creates pages in bulk using the attributes specified in the passed objects.
void	deleteContribution(Contribution contribution_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
void	deleteDraft(Long pageId_)	Deprecated. Cancels the changes made to the draft for the specified page, and clears the draft.
void	deletePage(Long pageId_)	Deprecated. Deletes the specified page.
int	getAccessLevelForPage(Long pageId_)	Deprecated. Gets the current user's access level for the given page.
int[]	getAccessLevelForPages(Long[] pageIds_)	Deprecated. Gets the current user's access levels for the given pages.
Contribution[]	getContributions()	Deprecated. This functionality is no longer supported and will be removed in the next release.
Contribution[]	getContributionsForType(Contribution contribution_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
ResultPage	getContributionsForTypePaging(Contribution contribution_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
Page	getDraft(Long pageId_)	Deprecated. Retrieves the draft version of the specified page.
int	getMaximumContributions()	Deprecated. This functionality is no longer supported and will be removed in the next release.
Page	getPage(Long pageId_)	Deprecated. Gets the specified portal page.
Page[]	getPages(Long[] pageIds_)	Deprecated. use getPagesPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer).
ResultList	getPagesList(Long[] pageIds_)	Deprecated. Gets the specified portal pages, returning the valid results even if all the results cannot be retrieved (for instance, if some of the pages corresponding to the IDs no longer exist).
ResultPage	getPagesPaging(Long[] pageIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. Gets the specified portal pages as an array of Page objects in a ResultPage.
PageRoleMap	getRoleMapForPage(Long pageId_)	Deprecated. Get the role map of a page, specifiying the administrators, editors and viewers of the page.
void	movePortlet(Long pageId_, Long portletId_, Integer zone_, int index_)	Deprecated. Attempts to lock the current draft of the specified page and move a portlet within the page.
Page	peekDraft(Long pageId_)	Deprecated. Retrieves the pending draft if present or the published page, without setting the draft owner.
void	publishDraft(Long pageId_)	Deprecated. Submits the current draft of the specified page for publication, and releases any lock on the draft.
void	publishDrafts(Long[] pageIds_)	Deprecated. Submits the current drafts of the specified pages for publication, and releases any lock on the drafts.
void	removePortlet(Long pageId_, Long portletId_, Integer action_)	Deprecated. Attempts to lock the current draft of the specified page and remove a portlet.
void	renamePage(Long pageId_, String newName_)	Deprecated. Renames the specified page to the specified name.
void	returnDraft(Long pageId_)	Deprecated. Returns a submitted page back to a draft state (Page.STATE_NEW_DRAFT or Page.STATE_DRAFT).
void	setIsPagePublic(Long pageId_, boolean isPublic_)	Deprecated. Changes whether the page is publicly viewable.
void	setMaximumContributions(int size_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
void	setPageApproval(Long pageId_, boolean approvalRequired_)	Deprecated. Sets whether approval is required for page modifications.
void	setPageCategory(Long pageId_, Long categoryId_)	Deprecated. Changes the category for the specified page.
void	setPageDataContextType(Long pageId, Long dataContextType)	Deprecated. Sets the type of data that will be sent to the page when it is requested.
void	setPageUrl(Long pageId_, String url_)	Deprecated. Changes the URL for the specified custom page.
void	setRoleMapForPage(Long pageId_, PageRoleMap map_)	Deprecated. Set the role map for a page
Page	takeDraft(Long pageId_)	Deprecated. Retrieves the draft version of the specified page and locks it for editing.
void	unlockDraft(Long pageId_)	Deprecated. Releases the lock on the draft for the specified page, if the current user owns the draft.
void	updateContribution(Contribution contribution_)	Deprecated. This functionality is no longer supported and will be removed in the next release.
void	updatePage(Page page_)	Deprecated. Updates a page using the attributes specified in the passed object.
void	updatePages(Page[] pages_)	Deprecated. Updates pages in bulk using the attributes specified in the passed objects.
boolean	validateTypedValues(TypedValue[] typedValues)	Deprecated. Validates given TypedValues.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Details

DELETE_PORTLET

static final Integer DELETE_PORTLET

Deprecated.

A constant representing the deletion of a portlet

DEACTIVATE_PORTLET

static final Integer DEACTIVATE_PORTLET

Deprecated.

A constant representing the deactivation of a portlet

getPage$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPages$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPages$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

createPage$UPDATES

@Deprecated(forRemoval=true)
static final boolean createPage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

createPages$UPDATES

@Deprecated(forRemoval=true)
static final boolean createPages$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updatePage$UPDATES

@Deprecated(forRemoval=true)
static final boolean updatePage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updatePages$UPDATES

@Deprecated(forRemoval=true)
static final boolean updatePages$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

deletePage$UPDATES

@Deprecated(forRemoval=true)
static final boolean deletePage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getAccessLevelForPage$UPDATES

@Deprecated(forRemoval=true)
static final boolean getAccessLevelForPage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

renamePage$UPDATES

@Deprecated(forRemoval=true)
static final boolean renamePage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

changePageDescription$UPDATES

@Deprecated(forRemoval=true)
static final boolean changePageDescription$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean getDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

peekDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean peekDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

takeDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean takeDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

approveDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean approveDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

deleteDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean deleteDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

publishDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean publishDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

publishDrafts$UPDATES

@Deprecated(forRemoval=true)
static final boolean publishDrafts$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

returnDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean returnDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

unlockDraft$UPDATES

@Deprecated(forRemoval=true)
static final boolean unlockDraft$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

changePageTemplate$UPDATES

@Deprecated(forRemoval=true)
static final boolean changePageTemplate$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setPageCategory$UPDATES

@Deprecated(forRemoval=true)
static final boolean setPageCategory$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setPageUrl$UPDATES

@Deprecated(forRemoval=true)
static final boolean setPageUrl$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setPageApproval$UPDATES

@Deprecated(forRemoval=true)
static final boolean setPageApproval$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setIsPagePublic$UPDATES

@Deprecated(forRemoval=true)
static final boolean setIsPagePublic$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

addPortlet$UPDATES

@Deprecated(forRemoval=true)
static final boolean addPortlet$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

removePortlet$UPDATES

@Deprecated(forRemoval=true)
static final boolean removePortlet$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

movePortlet$UPDATES

@Deprecated(forRemoval=true)
static final boolean movePortlet$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getRoleMapForPage$UPDATES

@Deprecated(forRemoval=true)
static final boolean getRoleMapForPage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setRoleMapForPage$UPDATES

@Deprecated(forRemoval=true)
static final boolean setRoleMapForPage$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

addContribution$UPDATES

@Deprecated(forRemoval=true)
static final boolean addContribution$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updateContribution$UPDATES

@Deprecated(forRemoval=true)
static final boolean updateContribution$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

deleteContribution$UPDATES

@Deprecated(forRemoval=true)
static final boolean deleteContribution$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getContributions$UPDATES

@Deprecated(forRemoval=true)
static final boolean getContributions$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getContributionsForType$UPDATES

@Deprecated(forRemoval=true)
static final boolean getContributionsForType$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getContributionsForTypePaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean getContributionsForTypePaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setMaximumContributions$UPDATES

@Deprecated(forRemoval=true)
static final boolean setMaximumContributions$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getMaximumContributions$UPDATES

@Deprecated(forRemoval=true)
static final boolean getMaximumContributions$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getAccessLevelForPages$UPDATES

@Deprecated(forRemoval=true)
static final boolean getAccessLevelForPages$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

addPortlets$UPDATES

@Deprecated(forRemoval=true)
static final boolean addPortlets$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPagesPaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPagesPaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getPagesList$UPDATES

@Deprecated(forRemoval=true)
static final boolean getPagesList$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

validateTypedValues$UPDATES

@Deprecated(forRemoval=true)
static final boolean validateTypedValues$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setPageDataContextType$UPDATES

@Deprecated(forRemoval=true)
static final boolean setPageDataContextType$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Method Details

getPage

@Read(K_PORTAL)
Page getPage(Long pageId_)
      throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException

Deprecated.

Gets the specified portal page. If a published version does not exist for the page, the draft is returned. If a submitted draft exists for the page, the draft is returned with the state set as Page.STATE_DRAFT. If a published version exists for the page, the published version is returned.

Parameters:

pageId_ - The ID of the page to retrieve.

Returns:

the requested page.

Throws:

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

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid; this exception is not thrown if the user is deactivated, so the caller should validate that the user is active before calling (known issue)

InvalidPageException - if the specified page does not exist

ServiceException - if any system-level error occurs

getPages

@Deprecated
@Read(K_PORTAL)
Page[] getPages(Long[] pageIds_)
         throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException,
NullPointerException

Deprecated.

use getPagesPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer).

Gets the specified portal pages. null is returned for each page that does not exist, or that the user is not authorized to view. Also see getPage(Long)

Parameters:

pageIds_ - the IDs of the portal pages to retrieve.

Returns:

the requested pages. An array item is set to null for each page that does not exist, or that the current user does not have permission to view.

Throws:

PrivilegeException - if the current user is anonymous and tries to view pages that anonymous users have no permission to access

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if any of the specified pages do not exist

ServiceException - if any system-level error occurs

NullPointerException - if the passed pageIds_ array or any of its elements is null

createPage

@Write(K_PORTAL)
Long createPage(Page page_)
         throws PrivilegeException,
InvalidAnonymousUserException,
InvalidUserException,
InvalidCategoryException,
DuplicateUuidException

Deprecated.

Creates a page using the attributes specified in the passed object. If a group attribute is specified, the current user must be an administrator of that group; creates the two way association between the group and the new page. The new page's state will be Page.STATE_NEW_DRAFT; only the creator and a portal administrator will be able to view/modify the page. The user making this call becomes the creator of the page.

Parameters:

page_ - The page to create. The following fields are the minimum required attributes that must not be null to successfully create the page: name, template (a tiles reference for the template JSP), zoneCount (see Page.setZoneCount(int)). The following attributes are optional: description, category, approvalRequired, group, public, type, and url (note: url is applicable only for page type PageInfo.TYPE_CUSTOM). For the allowed values for type see PageInfo.TYPE_XXX constants. All other attributes are ignored. This is the same whether or not the page is a custom page - attributes that don't make sense for a custom page (such as zoneCount) should just be given valid dummy values.

Returns:

The ID of the created page.

Throws:

PrivilegeException - if the current user is not allowed to create the specified page

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

IllegalArgumentException - if an invalid name or template was specified; this exception is not thrown if an invalid zoneCount is given, therefore the caller should validate that zoneCount > 0 and < 255

InvalidCategoryException - if the category ID was specified (is non-null), but does not correspond to a valid category

NullPointerException - if the passed page_ object is null

ServiceException - if any system-level error occurs

DuplicateUuidException - if the UUID of the page already exists

createPages

@Write(K_PORTAL)
Long[] createPages(Page[] pages_)
            throws PrivilegeException,
InvalidAnonymousUserException,
InvalidUserException,
InvalidCategoryException,
DuplicateUuidException

Deprecated.

Creates pages in bulk using the attributes specified in the passed objects. See createPage(Page).

Parameters:

pages_ - List of the pages to create. See createPage(Page)

Returns:

The IDs of the created pages.

Throws:

InvalidAnonymousUserException - If the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - If the user calling this method is invalid

IllegalArgumentException - if an invalid zone count, name or template was specified for any of the pages

PrivilegeException - If the current user is not allowed to create any of the pages

InvalidCategoryException - If the category ID was specified (is non-null) for any of the pages, but does not correspond to a valid category

NullPointerException - If the passed pages_ array or any of its elements is null

DuplicateUuidException - if the UUID of any of the pages already exists or if the same UUID is passed in for several pages

ServiceException - If any system-level error occurs

updatePage

@Write(K_PORTAL)
void updatePage(Page page_)
         throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidCategoryException,
InvalidPageException

Deprecated.

Updates a page using the attributes specified in the passed object.

This method does not create a new draft. It requires the current user to be an administrator of the group, if a group attribute is specified. This creates a two way association between the group and the page. A null value for group dissociates an existing two way association.

To update some of the ignored attributes of the page use the following:

• url - use setPageUrl(Long, String) instead.
• template and zoneCount - use changePageTemplate(Long, String, int) instead.
• rolemap - use setRoleMapForPage(Long, PageRoleMap) instead.
• portlets - use addPortlets(Long, Long[], Integer[], int[]) and removePortlet(Long, Long, Integer) instead.

Parameters:

page_ - the page to update. The following fields are the minimum required attributes that must not be null to successfully update the page: id, name and template (a tiles reference for the template JSP, although it's ignored).
The following attributes are optional: description, category, group, public. All other attributes are ignored. This is the same whether or not the page is a custom page - attributes that don't make sense for a custom page (such as zoneCount) should just be given valid dummy values.

Throws:

InvalidAnonymousUserException - If an anonymous User attempts to make this call.

InvalidUserException - If the current User does not exist.

PrivilegeException - If the current User is not an administrator of the Group specified in the group field of the Page or if the current user does not have sufficient privileges to update the Page.

InvalidCategoryException - not thrown, instead the category is reset to null if an invalid category is given (known issue)

NullPointerException - If the given page_ is null.

IllegalArgumentException - if either the name or template field is null.

InvalidPageException - If the Page given by the id field does not exist.

updatePages

@Write(K_PORTAL)
void updatePages(Page[] pages_)
          throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidCategoryException,
InvalidPageException

Deprecated.

Updates pages in bulk using the attributes specified in the passed objects. See updatePage(Page).

Parameters:

pages_ - The attributes of each page to update. See updatePage(Page)

Throws:

InvalidAnonymousUserException - If an anonymous User attempts to make this call.

InvalidUserException - If the current User does not exist.

PrivilegeException - If the current User is not an administrator of any one of the Group objects specified in the group field of the Page or if the current user does not have sufficient privileges to update any one of the Page objects.

InvalidCategoryException - If at least one of the given category fields is invalid.

NullPointerException - If any of the Page objects is null.

IllegalArgumentException - If either the name or template field in any of the given Page objects is null.

InvalidPageException - If any of the Page objects given by the id field does not exist.

deletePage

@Write(K_PORTAL)
void deletePage(Long pageId_)
         throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException

Deprecated.

Deletes the specified page.

Parameters:

pageId_ - the ID of the page to delete.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid; this exception is not thrown if a deactivated user is used to call this method, so the caller should validate that the user is not deactivated before calling (known issue)

PrivilegeException - if the current user is not allowed to delete the page

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

getAccessLevelForPage

@Read(K_PORTAL)
int getAccessLevelForPage(Long pageId_)
                   throws InvalidAnonymousUserException,
InvalidUserException,
InvalidPageException

Deprecated.

Gets the current user's access level for the given page.

Parameters:

pageId_ - the ID of the page for which the user's access level is to be returned.

Returns:

the access level of the current user for the specified page. This is one of the PAGE_ACCESS_LEVEL_XXX constants in PageInfo

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

renamePage

@Write(K_PORTAL)
void renamePage(Long pageId_,
 String newName_)
         throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException

Deprecated.

Renames the specified page to the specified name.

Parameters:

pageId_ - the ID of the page to rename.

newName_ - the new name of the page.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to rename the page

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

changePageDescription

@Write(K_PORTAL)
void changePageDescription(Long pageId_,
 String newDescription_)
                    throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException

Deprecated.

Changes the description of the specified page.

Parameters:

pageId_ - the ID of the page whose description should be changed.

newDescription_ - the new description for the page.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to change the page description

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

getDraft

@Write(K_PORTAL)
Page getDraft(Long pageId_)
       throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException

Deprecated.

Retrieves the draft version of the specified page.

• If a draft does not exist for the page, the published version is returned and the page is locked by the current user (no draft is created).
• If a draft exists and it is not locked by another user, the current draft is returned and is locked by the current user.
• If a draft exists and it is locked by another user, the current draft is returned but no changes will be allowed (the state will be Page.STATE_LOCKED).

Parameters:

pageId_ - the ID of the page whose draft should be returned.

Returns:

the requested page draft.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to view the page draft

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

See Also:

• takeDraft(java.lang.Long)

peekDraft

@Read(K_PORTAL)
Page peekDraft(Long pageId_)
        throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException

Deprecated.

Retrieves the pending draft if present or the published page, without setting the draft owner.

• If a draft does not exist for the page, the published version is returned.
• If a draft exists and it is not locked by another user, the current draft is returned without setting the draft owner.
• If a draft exists and it is locked by another user, the current draft is returned but no changes will be allowed (the state will be Page.STATE_LOCKED).

Parameters:

pageId_ - the ID of the page whose draft should be returned.

Returns:

the requested page draft.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to view the page draft

InvalidPageException - if the page with the specified ID does not exist

takeDraft

@Write(K_PORTAL)
Page takeDraft(Long pageId_)
        throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException

Deprecated.

Retrieves the draft version of the specified page and locks it for editing.

• If a draft does not exist for the page, the published version is returned and the page is locked by the current user (no draft is created).
• If a draft exists and it is not locked by another user, the current draft is returned and the page is locked by the current user.
• If a draft exists and it is locked by another user, the current draft is returned and the lock is reassigned to the current user.

Parameters:

pageId_ - the ID of the page whose draft should be returned.

Returns:

the requested page draft.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to view and lock the draft

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

See Also:

• getDraft(java.lang.Long)

approveDraft

@Write(K_PORTAL)
void approveDraft(Long pageId_)
           throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidStateException,
InvalidPageException

Deprecated.

Applies the changes made to the draft of the specified page, and clears the draft.

Parameters:

pageId_ - the ID of the page for which the draft should be approved.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to approve the page

InvalidStateException - if a draft does not exist for the specified page

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

deleteDraft

@Write(K_PORTAL)
void deleteDraft(Long pageId_)
          throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
LockException,
InvalidPageException,
NullPointerException,
InvalidStateException

Deprecated.

Cancels the changes made to the draft for the specified page, and clears the draft. For new pages (never published), removes all portlets and puts the page into the Page.STATE_NEW_DRAFT state. Only page admins and the user who originally created the draft can delete the draft.

Parameters:

pageId_ - the id of the page for which the draft should be deleted.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to delete the draft

LockException - if the draft is locked by another user

InvalidPageException - if the page with the specified ID does not exist

InvalidStateException - if the page has no draft

NullPointerException - if the argument is null

ServiceException - if any system-level error occurs

publishDraft

@Write(K_PORTAL)
void publishDraft(Long pageId_)
           throws InvalidAnonymousUserException,
InvalidUserException,
InvalidStateException,
PrivilegeException,
InvalidPageException

Deprecated.

Submits the current draft of the specified page for publication, and releases any lock on the draft. If approval is required, the page will only be published after approveDraft(java.lang.Long) is called, otherwise the page is published immediately. It associates the page with the group (group->page) if there was a group associated with the page (page->group).

If a System Administrator user calls this method on a page that requires approval, the Page will enter the Page.STATE_PUBLISHED state even if that user is not a member of Portal Administrators.

Parameters:

pageId_ - the ID of the page for which the draft should be published.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidStateException - if a draft does not exist for the specified page

PrivilegeException - if the current user is not allowed to publish the page

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

publishDrafts

@Write(K_PORTAL)
void publishDrafts(Long[] pageIds_)
            throws InvalidAnonymousUserException,
InvalidUserException,
InvalidStateException,
PrivilegeException,
InvalidPageException

Deprecated.

Submits the current drafts of the specified pages for publication, and releases any lock on the drafts. See updatePage(Page).

Parameters:

pageIds_ - the IDs of the pages for which the drafts should be published.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidStateException - if a draft does not exist for any of the specified pages

PrivilegeException - if the current user is not allowed publish the pages

InvalidPageException - if any of the IDs does not correspond to a valid page

ServiceException - if any system-level error occurs

returnDraft

@Write(K_PORTAL)
void returnDraft(Long pageId_)
          throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidStateException,
InvalidPageException,
NullPointerException

Deprecated.

Returns a submitted page back to a draft state (Page.STATE_NEW_DRAFT or Page.STATE_DRAFT).

Parameters:

pageId_ - the id of the page which should be returned to a draft.

Throws:

InvalidStateException - if the page state is not Page.STATE_NEW_SUBMITTED or Page.STATE_SUBMITTED

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not an approver of the page

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

NullPointerException - if the passed page id is null

unlockDraft

@Write(K_PORTAL)
void unlockDraft(Long pageId_)
          throws LockException,
InvalidPageException

Deprecated.

Releases the lock on the draft for the specified page, if the current user owns the draft.

Parameters:

pageId_ - the id of the page for which the draft lock should be released.

Throws:

LockException - if the current user does not own the draft

InvalidPageException - if the page with the specified ID does not exist

ServiceException - if any system-level error occurs

changePageTemplate

@Write(K_PORTAL)
void changePageTemplate(Long pageId_,
 String newTemplateName_,
 int newZoneCount_)
                 throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
LockException,
IllegalArgumentException,
InvalidPageException,
NullPointerException

Deprecated.

Attempts to lock the current draft for the specified page (i.e., put the page into draft state) and changes the template in the draft.

Parameters:

pageId_ - The ID of the page for which the template should be changed.

newTemplateName_ - The name of the new template, which should be a tiles reference.

newZoneCount_ - The number of zones that can contain portlets. See Page.getZoneCount().

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - If the user calling this method is invalid

PrivilegeException - If the current user is not allowed to modify the page

LockException - If the draft is locked and the current user does not own the draft

IllegalArgumentException - If an invalid zone count is used

InvalidPageException - If the page with the specified ID does not exist

NullPointerException - If any argument is null.

ServiceException - If any system-level error occurs

See Also:

• getDraft(java.lang.Long)

setPageCategory

@Write(K_PORTAL)
void setPageCategory(Long pageId_,
 Long categoryId_)
              throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidCategoryException,
InvalidPageException

Deprecated.

Changes the category for the specified page.

Parameters:

pageId_ - the ID of the page for which the category should be set.

categoryId_ - the ID of the category to which to add the page.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to set the category for the page

InvalidPageException - if the page with the specified ID does not exist

InvalidCategoryException - if no category with the specified ID exists

ServiceException - if any system-level error occurs

setPageUrl

@Write(K_PORTAL)
void setPageUrl(Long pageId_,
 String url_)
         throws InvalidPageException,
InvalidOperationException,
PrivilegeException

Deprecated.

Changes the URL for the specified custom page. This does not change the state of the page.

Parameters:

pageId_ - the ID of the page for which the URL should be set.

url_ - the new URL for the page.

Throws:

InvalidPageException - if no page with the specified ID exists

InvalidOperationException - if the page is not a custom page

PrivilegeException - if the current user is not allowed to change the URL for the page

setPageApproval

@Write(K_PORTAL)
void setPageApproval(Long pageId_,
 boolean approvalRequired_)
              throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException

Deprecated.

Sets whether approval is required for page modifications. Automatically approves any pending submissions if the approval is changed from true to false.

Parameters:

pageId_ - the ID of the page for which the approval should be set.

approvalRequired_ - specifies whether approval will be required for page modifications.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to change the approval setting for the page

InvalidPageException - if no page with the specified ID exists

ServiceException - if any system-level error occurs

setIsPagePublic

@Write(K_PORTAL)
void setIsPagePublic(Long pageId_,
 boolean isPublic_)
              throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException

Deprecated.

Changes whether the page is publicly viewable.

Parameters:

pageId_ - the ID of the page for which the viewable setting should be changed.

isPublic_ - specifies whether the page will be publicly viewable.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to change the viewable setting for the page

InvalidPageException - if no page with the specified ID exists

ServiceException - if any system-level error occurs

addPortlet

@Write(K_PORTAL)
void addPortlet(Long pageId_,
 Long portletId_,
 Integer zone_,
 int index_)
         throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
PortletSharingException,
DuplicatePortletException,
InvalidPageException,
InvalidPortletException,
InvalidZoneException,
LockException,
NullPointerException

Deprecated.

Attempts to lock the current draft of the specified page and add a portlet.

Parameters:

pageId_ - the ID of the page to which the portlet should be added.

portletId_ - the ID of the portlet to add to the page.

zone_ - Specifies which zone will contain the portlet. The zone identifies which column the portlet should be placed into, with the indexing starting at 0 (left-most column).

index_ - Specifies the position of the portlet within the zone, with the indexing starting at 0 (top-most position).

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to modify the page

PortletSharingException - if the specified portlet is non-shareable, and is already on another page

DuplicatePortletException - if the specified portlet already exists on the draft

InvalidPageException - if no page with the specified ID exists

InvalidPortletException - if no portlet with the specified ID exists

InvalidZoneException - if the specified zone does not exist

LockException - if the current user does not own the draft

ServiceException - if any system-level error occurs

NullPointerException - if any argument is null

removePortlet

@Write(K_PORTAL)
void removePortlet(Long pageId_,
 Long portletId_,
 Integer action_)
            throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
LockException,
InvalidPageException,
InvalidPortletException

Deprecated.

Attempts to lock the current draft of the specified page and remove a portlet. If the portlet is not shareable and it is not on the published version (if any) of the page, the portlet itself is also deleted from the database. If the portlet is not shareable but is on the published version of the page, then the portlet itself will be deleted when the draft version of the page becomes the published version.

Parameters:

pageId_ - the ID of the page from which the portlet should be removed.

portletId_ - the ID of the portlet to remove.

action_ - The action to take (DELETE_PORTLET or DEACTIVATE_PORTLET).

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to remove the portlet

LockException - if the current user does not own the page draft

InvalidPageException - if no page with the specified ID exists

InvalidPortletException - if no portlet with the specified ID exists

ServiceException - if any system-level error occurs

movePortlet

@Write(K_PORTAL)
void movePortlet(Long pageId_,
 Long portletId_,
 Integer zone_,
 int index_)
          throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
LockException,
InvalidZoneException,
InvalidPageException,
InvalidPortletException,
NullPointerException

Deprecated.

Attempts to lock the current draft of the specified page and move a portlet within the page.

Parameters:

pageId_ - the ID of the page in which the portlet should be moved.

portletId_ - the ID of the portlet to move.

zone_ - specifies the new zone that will contain the portlet. The zone identifies which column the portlet should be placed into, with the indexing starting at 0 (left-most column).

index_ - specifies the position of the portlet within the zone, with the indexing starting at 0 (top-most position).

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to modify the page

LockException - if the current user does not own the page draft

InvalidZoneException - if the specified zone does not exist

InvalidPageException - if no page with the specified ID exists

InvalidPortletException - if no portlet with the specified ID exists

ServiceException - if any system-level error occurs

NullPointerException - if any argument is null

getRoleMapForPage

@Read(K_PORTAL)
PageRoleMap getRoleMapForPage(Long pageId_)
                       throws InvalidPageException,
PrivilegeException

Deprecated.

Get the role map of a page, specifiying the administrators, editors and viewers of the page.

Parameters:

pageId_ - the ID of the page.

Returns:

the page rolemap.

Throws:

PrivilegeException - if the current user is not allowed to view the page rolemap

InvalidPageException - if no page with the specified ID exists

ServiceException - if any system-level error occurs

See Also:

• PageRoleMap

setRoleMapForPage

@Write(K_PORTAL)
void setRoleMapForPage(Long pageId_,
 PageRoleMap map_)
                throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
InvalidPageException,
NullPointerException

Deprecated.

Set the role map for a page

Parameters:

pageId_ - the ID of the page.

map_ - the new rolemap of the page.

Throws:

InvalidAnonymousUserException - if the current user is anonymous or the anonymous user is in the rolemap, but anonymous access has not been enabled.

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to set the rolemap for the page

InvalidPageException - if no page with the specified ID exists

NullPointerException - if any argument is null

ServiceException - if any system-level error occurs

See Also:

• PageRoleMap

addContribution

@Deprecated
@Write(K_PORTAL)
void addContribution(Contribution contribution_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Adds a new contribution. User contributions can be logged with this method for any Appian Object that is supported in LocalObject. Currently contributions are logged when a user creates or edits a message, thread or page and when the user uploads a document.

Parameters:

contribution_ - the contribution to add. The type, id, and author fields should be set. The timestamp will be set by the system.

Throws:

ServiceException - if any system-level error occurs

NullPointerException - if contribution_ is null

See Also:

• LocalObject

updateContribution

@Deprecated
@Write(K_PORTAL)
void updateContribution(Contribution contribution_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Updates a contribution. A user contribution can be logged with this method for any Appian Object that is supported in LocalObject. Currently contributions are logged when a user creates or edits a message, thread or page and when the user uploads a document.

Parameters:

contribution_ - the contribution to update. The type, id, and author fields should be set. The timestamp will be set by the system.

Throws:

ServiceException - if any system-level error occurs

NullPointerException - if contribution_ is null

See Also:

• LocalObject

deleteContribution

@Deprecated
@Write(K_PORTAL)
void deleteContribution(Contribution contribution_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Deletes a contribution.

Parameters:

contribution_ - the contribution to delete. The type and id fields should be set.

Throws:

NullPointerException - if contribution_ is null

ServiceException - if any system-level error occurs

getContributions

@Deprecated
@Read(K_PORTAL)
Contribution[] getContributions()

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Gets the current user's contributions.

Returns:

the contributions of the current user.

Throws:

ServiceException - if any system-level error occurs

getContributionsForType

@Deprecated
@Read(K_PORTAL)
Contribution[] getContributionsForType(Contribution contribution_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Gets the current user's contributions of a certain type; the number of contributions returned is limited to a pre-defined maximum which can be retrieved using getMaximumContributions() and set to a new value using setMaximumContributions(int). To retrieve the current user's authored threads set the author field of the passed contribution_ to Contribution.AUTHOR_ON. To retrieve the threads in which the current user has participated set the author field of the passed contribution_ to Contribution.AUTHOR_OFF. For contributions other than threads, the author field reflects whether the user created (Contribution.AUTHOR_ON) or updated (Contribution.AUTHOR_OFF) the contribution.

Parameters:

contribution_ - a Contribution object whose type and author should be set to determine the type and author of the retrieved contributions.

Returns:

The current user's contributions of the passed type, sorted by timestamp from most recent to least recent.

Throws:

ServiceException - if any system-level error occurs

getContributionsForTypePaging

@Deprecated
@Read(K_PORTAL)
ResultPage getContributionsForTypePaging(Contribution contribution_,
 int startIndex_,
 int batchSize_,
 Integer sortProperty_,
 Integer sortOrder_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Gets the current user's contributions of a certain type. To retrieve the current user's authored threads set the author field of the passed contribution_ to Contribution.AUTHOR_ON. To retrive the threads in which the current user has participated set the author field of the passed contribution_ to Contribution.AUTHOR_OFF. For contributions other than threads, the author field reflects whether the user created (Contribution.AUTHOR_ON) or updated (Contribution.AUTHOR_OFF) the contribution.

Parameters:

contribution_ - a Contribution object whose type and author should be set to determine the type and author of the retrieved contributions.

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. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Contribution.

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

Returns:

a ResultPage containing a list of Contribution objects of the passed type.

Throws:

NullPointerException - if contribution_ is null

ServiceException - if any system-level error occurs

setMaximumContributions

@Deprecated
@Write(K_PORTAL)
void setMaximumContributions(int size_)

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Sets the maximum number of contributions to be returned by getContributionsForType(Contribution).

Parameters:

size_ - The maximum number of contributions to be returned by getContributionsForType(Contribution).

Throws:

ServiceException - if any system-level error occurs

See Also:

• Contribution

getMaximumContributions

@Deprecated
@Read(K_PORTAL)
int getMaximumContributions()

Deprecated.

This functionality is no longer supported and will be removed in the next release.

Gets the maximum number of contributions to be returned by getContributionsForType(Contribution).

Returns:

The maximum number of contributions to be returned by getContributionsForType(Contribution).

Throws:

ServiceException - if any system-level error occurs

See Also:

• Contribution

getAccessLevelForPages

@Read(K_PORTAL)
int[] getAccessLevelForPages(Long[] pageIds_)
                      throws InvalidAnonymousUserException,
InvalidUserException,
InvalidPageException,
NullPointerException

Deprecated.

Gets the current user's access levels for the given pages.

Parameters:

pageIds_ - the IDs of the pages for which the user's access levels should be returned.

Returns:

the access levels of the current user for the specified pages. Each access level will be one of the PAGE_ACCESS_LEVEL_XXX constants in PageInfo.

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

InvalidPageException - if any of the specified pages does not exist

NullPointerException - if pageIds_ is null

ServiceException - if any system-level error occurs

addPortlets

@Write(K_PORTAL)
void addPortlets(Long pageId_,
 Long[] portletIds_,
 Integer[] zones_,
 int[] indices_)
          throws InvalidAnonymousUserException,
InvalidUserException,
PrivilegeException,
PortletSharingException,
DuplicatePortletException,
InvalidPageException,
InvalidPortletException,
InvalidZoneException,
LockException,
NullPointerException

Deprecated.

Attempts to lock the current draft of the specified page and add portlets.

Parameters:

pageId_ - the ID of the page to which the portlets should be added.

portletIds_ - the IDs of the portlets to add to the page.

zones_ - specifies which zone will contain the portlet with the same array index. The zone identifies which column the portlet should be placed into, with the indexing starting at 0 (left-most column).

indices_ - specifies the position within the zone of the portlet with the same array index. The position indexing starts at 0 (top-most position).

Throws:

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user is not allowed to modify the page

PortletSharingException - if any portlet is non-shareable, and is already on another page

DuplicatePortletException - if any specified portlet already exists on the draft

InvalidPageException - if no page with the specified ID exists

InvalidPortletException - if any of the portlet IDs does not correspond to a valid portlet

InvalidZoneException - if any specified zone does not exist

LockException - if the current user does not own the draft

NullPointerException - if any argument is null

ServiceException - if any system-level error occurs

See Also:

• addPortlet(java.lang.Long, java.lang.Long, java.lang.Integer, int)

getPagesPaging

@Read(K_PORTAL)
ResultPage getPagesPaging(Long[] pageIds_,
 int startIndex_,
 int batchSize_,
 Integer sortProperty_,
 Integer sortOrder_)
                   throws PrivilegeException,
InvalidPageException,
InvalidAnonymousUserException,
InvalidUserException,
NullPointerException

Deprecated.

Gets the specified portal pages as an array of Page objects in a ResultPage. null is returned for each page that does not exist, or that the user is not allowed to view.

Parameters:

pageIds_ - the IDs of the portal pages to retrieve.

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. Negative numbers will result in the entire collection being returned, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results should be sorted. This should be one of the SORT_BY_XXX constants defined in Page.

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

Returns:

a ResultPage containing an array of Page objects. The array may contain null items if the current user does not have permission to view particular pages, or of particular pages do not exist

Throws:

PrivilegeException - if the current user is anonymous and anonymous users cannot view any of the given pages

InvalidPageException - if any of the IDs does not correspond to a valid page

InvalidAnonymousUserException - if the current user is anonymous, but anonymous access has not been enabled

InvalidUserException - if the user calling this method is invalid

NullPointerException - if the passed pageIds_ array or any of its elements is null

ServiceException - if any system-level error occurs

See Also:

• Page

getPagesList

@Read(K_PORTAL)
ResultList getPagesList(Long[] pageIds_)

Deprecated.

Gets the specified portal pages, returning the valid results even if all the results cannot be retrieved (for instance, if some of the pages corresponding to the IDs no longer exist).

Parameters:

pageIds_ - the IDs of the pages that should be retrieved.

Returns:

a ResultList containing pages and error codes. The Result.getResults() method should be used to get all the pages that were successfully retrieved. In addition, ResultList.getResultCodes() can be used to get the list of result codes corresponding to each of the specified page IDs. Each code represents the successful retrieval of a page, or, if the page could not be retrieved, the reason for the failure; this is one of the CODE_XXX or PORTAL_CODE_XXX constants defined in ResultList.

Throws:

ServiceException - if any system-level error occurs

validateTypedValues

@Read(K_PORTAL)
boolean validateTypedValues(TypedValue[] typedValues)

Deprecated.

Validates given TypedValues. This method is free to throw an exception or to return false if any TypedValue passed is invalid for this engine. This engine supports: AppianType.PAGE AppianType.PORTLET

Parameters:

typedValues -

Returns:

true if valid, false if invalid

setPageDataContextType

@Write(K_PORTAL)
void setPageDataContextType(Long pageId,
 Long dataContextType)

Deprecated.

Sets the type of data that will be sent to the page when it is requested. Passing a null clear its value.

Parameters:

pageId - the ID of the page whose data context should be changed.

dataContextType - id of data context type; null if clearing the context.