PageSet (Component)

CommonSpot allows for the management of groups of related pages as page sets. Pages within a page set are organized in a logical sequence and can be reordered at any time. Using the PageSet object, you can both manage and obtain information about page sets. Methods for managing the object let you: * Create, delete, and move page sets. * Add, remove, and replace all members. Set locks and change ownership. * Obtain information on a page set such as its members, referring objects, subsite, element usage, and so on.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Methods marked below with [C] may be customized at the site level

Methods:

addMembers [L] [C]	Adds one or more members to the end of the page set list.
changeOwner [L] [C]	Changes the owner of a page set.
create [L] [C]	Creates a page set.
delete [L] [C]	Deletes a page set.
getElementUsage [C]	Returns zero or more structures, each containing information on pages that contain one or more page set elements.
getElementUsageCount [C]	Returns the number of pages that contain one or more page set elements that reference a page set.
getInfo [C]	Returns a structure containing general information on a PageSet; for example, the page set's availability, name, number of members, and so on.
getMembers [C]	Returns zero or more structures, each containing information on the members of a page set. Examples of this structure's members are 'ID', 'MyApproval', and 'MyWIP'.
getOwnerID [C]	Returns the ID of the user or group that owns this page set.
getReferringObjects [C]	Returns zero or more structure, each containing information about a referred object; for example, the link and page type, the page's title, and its subsite URL.
getReferringObjectsCount [C]	Returns the number of pages and objects with links to the specified page set.
getSubsiteID [C]	Returns the subsite ID of the subsite in which the specified page set resides.
move [L] [C]	Moves a page set to the current subsite. If CommonSpot cannot move the page set, it throws an error and does not move the page set.
removeMember [L] [C]	Removes a member page from a page set.
removeMembers [C]	Remove one or more members from a page set.
saveInfo [L] [C]	Updates the standard metadata for the specified page set.
setMembers [L] [C]	Replaces all members of a page set with a new set of pages.