Skip navigation links

oracle.webcenter.page.model
Interface PageService

public interface PageService

Since:

release specific (what release of product did this appear in)

Method Summary

PageDef	addPageEntry(java.lang.String grantee, java.lang.String pagepath, java.lang.String title, boolean hidden, boolean shared) Creates an entry of the page in pages.xml for a user or role.
void	changePagePermission(java.lang.String servicePermission, java.lang.String pagePath, java.lang.Boolean invalidateBindings) Changes global permissions to custom page permissions and vice versa.
PageDef	copyPage(java.lang.String srcPage, java.lang.String srcPath, java.lang.String destPageNameFormat, java.lang.String destPath, java.lang.String destPageTitle) Copies a page with name and destination path.
PageDef	copyPage(java.lang.String srcPage, java.lang.String srcPath, java.lang.String parentPagePath, java.lang.String destPageNameFormat, java.lang.String destPath, java.lang.String destPageTitle, java.lang.String copyAfterPagePath) Copies a page with name and destination path under a parent page.
PageDef	copyPageForGroupSpace(java.lang.String srcPage, java.lang.String srcPath, java.lang.String destPageNameFormat, java.lang.String destPath, java.lang.String destPageTitle) Copies a page with name and destination path a group space is provisioned.
void	copyPagesSequence(java.lang.String srcPath, java.lang.String destPath) Copies the page sequence of a scope to another scope.
void	createEmptyMetadata(java.lang.String path) Creates an empty page.xml file under the path.
PageDef	createHierarchyPage(java.lang.String parentPagePath, java.lang.String nameFormat, java.lang.String title, java.lang.String pageStylePath, java.lang.String pageTemplatePath, java.lang.String createAfterPagePath) Creates a sub page.
PageDef	createPage(java.lang.String pageType, java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a page in the target location.
PageDef	createPage(java.lang.String pageType, java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String ADFTemplateViewID, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a page in the target location.
PageDef	createPage(java.lang.String pageType, java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String contentMRef, java.lang.String viewID, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a page in the target location using the specified contentMRef.
PageDef	createPageMetadata(java.lang.String path, java.lang.String title, java.lang.String mRef, java.lang.Boolean hidden, java.lang.Boolean shared) Creates the page metadata in the target location specified by the path.
PageDef	createPageMetadataInBase(java.lang.String path, java.lang.String title, java.lang.String mRef, java.lang.Boolean hidden, java.lang.Boolean shared) Creates the page metadata in the target location specified by the path.
PageDef	createTaskflow(java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a taskflow in the target location.
PageDef	createTaskflow(java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String ADFTemplateViewID, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a taskflow in the target location.
PageDef	createTaskflowWithoutFlush(java.lang.String nameFormat, java.lang.String title, java.lang.String pageTemplate, java.lang.String pageTemplatePath, java.lang.String cssStyle, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Creates a taskflow in the target location without flushing
void	deletePage(PageDef page) Deletes a page.
void	deletePage(java.lang.String pagePath) Deletes a page.
void	deletePageForGroupSpace(PageDef page) Deletes a page when a Space is unprovisioned.
void	deletePageMetadata(PageDef page) Deletes a page metadata from the pages.xml file.
void	deletePageMetadata(java.lang.String pageMetadataPath, PageDef page) Deletes a page metadata from the given pages.xml file.
void	deletePagePersonalization(java.lang.String pagePath) Deletes the customization layer and any translation(s) of the page.
void	deleteTaskflow(java.lang.String taskflowPath) Deletes a task flow.
java.util.List<PageDef>	getAllChildren(java.lang.String parentPagePath) Gets the list of all pages in the hierarchy tree under a parent page.
java.util.List<PageDef>	getAllPages() Gets all pages.
java.util.List<PageDef>	getAllPagesForAdmin() Gets all pages including business role pages and personal pages for for administrator.
java.util.List<PageDef>	getAllPagesNoPermission() Gets all the pages bypassing the security checks.
java.util.List<java.lang.String>	getAllPersonalPageOwners() Gets all user IDs that own personal pages.
java.util.List<PageDef>	getBusinessRolePages() Gets all business role pages.
java.util.List<PageDef>	getCachedPersonalPages() Gets the list of pages from cache for the user in the Home Space.
PageDef	getDynamicMappingPage(java.lang.String pagePath) Gets a page which uses dynamic page mapping by its full path
java.util.List<TemplateDef>	getGroupSpaceTemplates(java.lang.String tempFile) Deprecated.
PageDef	getHierarchyPage(java.lang.String pagePath) Gets a hierarchical page
PageDef	getPage(java.lang.String pagePath) Gets a page by its name by full path.
PageDef	getPageByContentMRef(java.lang.String contentMRef) Gets a page by its full path.
PageDef	getPageByName(java.lang.String pageName) Gets a page by its name.
PageDef	getPageByViewID(java.lang.String pageViewID) Gets a page by its full path.
PageDef	getPageDefAttributes(java.lang.String pagePath) Gets a page's metadata defined in the page definition.
org.w3c.dom.Document	getPageDefDocumentForUpdate(java.lang.String pagePath) Gets a page's page definition document for updating.
java.util.List<PageDef>	getPageHierarchy(java.lang.String parentPagePath) Gets the list of pages under a parent page.
PageDef	getPageInBusinessRolePages(java.lang.String pagePath) Gets a page by its name with full path from the business pages
PageDef	getPageInScope(java.lang.String pagePath) Gets a page by its name with full path in the current scope.
java.util.List<PageDef>	getPageList() Gets all pages that the user can view.
java.util.List<PageDef>	getPageList(java.lang.String path) Gets all pages that the user can view.
java.lang.String	getPagePermission(java.lang.String pagePath) Gets the permission class associated with the page specified by the page path.
java.util.List<PageResource>	getPageResources(java.util.List<java.lang.String> pagePaths) Gets the list of page resources for the list of page paths.
oracle.webcenter.page.model.PageSchemeDef	getPageScheme(java.lang.String pagepath) Gets the page's scheme properties in the jspx page
java.lang.String	getPageSecurityTarget(java.lang.String pagePath) Gets the page security target from the page specified by the page path.
java.util.List<TemplateDef>	getPageStyleSiteResources() Gets page styles from the generic site resources.
java.util.List<PageDef>	getParentHierarchy(java.lang.String parenPagePath) Gets the list of parent pages for a page.
PageDef	getParentPage(java.lang.String pagePath) Gets the parent page.
java.util.List<PageResource>	getParentResourceHierarchy(java.lang.String pagePath) Get the list of parent page resources for a page
java.util.List<PageDef>	getPersonalPages() Gets all personal pages.
java.util.List<PageDef>	getPersonalPages(java.lang.String userIdentifier) Gets all personal pages of a user.
java.lang.String[]	getPortletIds(java.lang.String pagePath) Gets the portlet instance IDs on a page
java.util.List<SchemeDef>	getPSSchemes() Deprecated.
java.util.List<SchemeDef>	getSchemes() Deprecated.
java.lang.String	getScope() Gets the current scope.
java.util.List<java.lang.String>	getSubFolders(java.lang.String path, int level) Deprecated.
java.util.List<TemplateDef>	getTemplates(java.lang.String tempFile) Deprecated.
void	grantPagePermission(java.lang.String pagePath, java.lang.String granteeName, java.lang.String permissions) Grants page permission to the grantee.
boolean	hasCopyGroupSpaceLock(java.lang.String sourceSpacePath) Obtains MDS lock to copy a Space.
boolean	hasDeleteGroupSpaceLock(java.lang.String path) Obtains MDS lock to delete a Space.
void	hidePage(java.lang.String pagepath) Hides a page in the scope.
void	hidePage(java.lang.String pagepath, java.lang.String parentPath) Hides a page in the hierarchy.
void	hidePageInBusinessRolePages(java.lang.String pagepath) Hides a page in the business pages.
void	invalidateScopeCache() Invalidate all data for the current scope.
void	invalidateScopeCache(oracle.webcenter.framework.service.Scope scope) Invalidate all data for the specified scope.
void	invalidateScopeUserCache(java.lang.String userName) Invalidates all cache objects for a user in the current scope.
void	invalidateUserCache(java.lang.String userName) Invalidates all cache objects for a user.
boolean	isPageNameUnique(java.lang.String scopeName, java.lang.String pageName) Checks if a page name is unique within a scope.
boolean	isPageStyleAvailable(java.lang.String pageStyleName) Checks if a page style is available
boolean	isReadOnly(java.lang.String path) Gets read-only flag set for the scope.
boolean	metadataObjectExists(java.lang.String path) Checkis if the metadata object with the specific path exists
void	moveAfterPage(java.lang.String pagePath, java.lang.String afterPagePath) Moves a page after the specified page.
void	moveBeforePage(java.lang.String pagePath, java.lang.String beforePagePath) Moves a page before the specified page
PageDef	movePage(java.lang.String pagePath, java.lang.String parentPagePath) Moves page under a new parent.
void	removePageEntry(java.lang.String grantee, java.lang.String pagepath) Removes the entry of the page from the pages.xml file for a user or role.
void	revokePagePermission(java.lang.String pagePath, java.lang.String granteeName) Revokes page permission from the grantee.
void	saveChanges() Persists the changes made in the current scope in the repository.
java.util.List<PageDef>	searchChildPages(java.lang.String parentPagePath, java.lang.String searchString) Searches the direct child pages of a page.
java.util.List<PageDef>	searchPageHierarchy(java.lang.String parenPagePath, java.lang.String searchString) Searches the page hierarchy.
void	sequencePageAfter(java.lang.String pagePath, java.lang.String afterPagePath) Sequences page after another page.
void	sequencePageBefore(java.lang.String pagePath, java.lang.String beforePagePath) Sequences page before another page.
void	sequencePageEnd(java.lang.String pagePath) Sequences page to the end in the list.
void	sequencePageFront(java.lang.String pagePath) Sequences the page on the top of the list.
void	setPageScheme(java.lang.String pagepath, java.lang.String schemeName, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Updates the page's scheme properties in the jspx page.
void	setPageScheme(java.lang.String pagepath, java.lang.String schemeName, java.lang.String schemeBGImage, java.lang.String schemeBGColor, java.lang.String otherCSS) Updates the page's scheme properties in the jspx page
void	setPageTitle(java.lang.String pagepath, java.lang.String title) Updates the name of the page
void	setReadOnly(boolean readOnly, java.lang.String path) Set read-only flag for the scope.
void	setScope(java.lang.String scope) Sets the current scope.
void	showPage(java.lang.String pagepath) Shows a page in the scope.
void	showPage(java.lang.String pagepath, java.lang.String parentPath) Shows a page in the hierarchy.
void	showPageInBusinessRolePages(java.lang.String pagepath) Shows a page in the business pages.
void	updatePageDefAttributes(PageDef page) Updates the page attributes in page definition file and commits changes based on the specified page.
void	updatePageDefBaseAttributes(PageDef page) Updates the page attributes in the base page definition file and commits changes based on the specified page.
void	wireTaskFlows(java.lang.String fromTaskFlowId, java.lang.String fromTaskFlowDefId, java.lang.String toTaskFlowId, java.lang.String toTaskFlowDefId, java.lang.String fromTaskFlowAction, java.lang.String toTaskFlowAction) Deprecated.

Method Detail

setScope

void setScope(java.lang.String scope)

Sets the current scope.

Parameters:

scope - the current scope

getScope

java.lang.String getScope()

Gets the current scope.

Returns:

the current scope.

metadataObjectExists

boolean metadataObjectExists(java.lang.String path)

Checkis if the metadata object with the specific path exists

Parameters:

path - the MDS path of the object

Returns:

true if it exist. Otherwise false

getAllPages

java.util.List<PageDef> getAllPages()

Gets all pages.

Returns:

the list of all pages in the current scope regardless of the status.

getAllPagesNoPermission

java.util.List<PageDef> getAllPagesNoPermission()

Gets all the pages bypassing the security checks. This is required because the MBean call to the API contains the subject as null and hence all permission checks fail.

Returns:

the list of all pages in the current scope regardless of the status.

getPageList

java.util.List<PageDef> getPageList()

Gets all pages that the user can view.

Returns:

the list of all pages that are not hidden in the current scope

getPageList

java.util.List<PageDef> getPageList(java.lang.String path)

Gets all pages that the user can view.

Parameters:

path - the path

Returns:

the list of all pages that are not hidden under a specific path

getBusinessRolePages

java.util.List<PageDef> getBusinessRolePages()

Gets all business role pages.

Returns:

the list of all business role pages regardless of their status.

getPersonalPages

java.util.List<PageDef> getPersonalPages()

Gets all personal pages.

Returns:

the list of all personal pages regardless of their status.

getAllPagesForAdmin

java.util.List<PageDef> getAllPagesForAdmin()

Gets all pages including business role pages and personal pages for for administrator.

Returns:

the list of all business role pages and personal pages regardless of their status.

getPersonalPages

java.util.List<PageDef> getPersonalPages(java.lang.String userIdentifier)

Gets all personal pages of a user.

Returns:

the list of personal pages of a user

getAllPersonalPageOwners

java.util.List<java.lang.String> getAllPersonalPageOwners()

Gets all user IDs that own personal pages.

Returns:

the list of user IDs

getCachedPersonalPages

java.util.List<PageDef> getCachedPersonalPages()

Gets the list of pages from cache for the user in the Home Space.

Returns:

the list of a user's pages

getPageHierarchy

java.util.List<PageDef> getPageHierarchy(java.lang.String parentPagePath)

Gets the list of pages under a parent page.

Parameters:

parentPagePath - the path of the parent page. If it is null or a scope name, get the top level pages of this scope.

Returns:

the list of pages

getAllChildren

java.util.List<PageDef> getAllChildren(java.lang.String parentPagePath)

Gets the list of all pages in the hierarchy tree under a parent page.

Parameters:

parentPagePath - the path of the parent page.

Returns:

the list of all children pages

searchPageHierarchy

java.util.List<PageDef> searchPageHierarchy(java.lang.String parenPagePath,
                                            java.lang.String searchString)

Searches the page hierarchy.

Parameters:

parenPagePath - the path of the parent page. It can be a scope name. If it is null, the current scope is used

Returns:

the list of pages in the a hierarchy whose page names match the search string

searchChildPages

java.util.List<PageDef> searchChildPages(java.lang.String parentPagePath,
                                         java.lang.String searchString)

Searches the direct child pages of a page.

Parameters:

parenPagePath - the path of the parent page. It can be a scope name. If it is null, the current scope is used

Returns:

the list of child pages whose page name is the same as the search string

getParentPage

PageDef getParentPage(java.lang.String pagePath)

Gets the parent page.

Parameters:

pagePath - the path of the page

Returns:

the parent page

getHierarchyPage

PageDef getHierarchyPage(java.lang.String pagePath)

Gets a hierarchical page

Parameters:

pagePath - the path of the page

Returns:

the page

getParentHierarchy

java.util.List<PageDef> getParentHierarchy(java.lang.String parenPagePath)

Gets the list of parent pages for a page.

Parameters:

parenPagePath - the path of the parent page. It can be a scope name. If it is null, the current scope is used

Returns:

the list of parent pages

getParentResourceHierarchy

java.util.List<PageResource> getParentResourceHierarchy(java.lang.String pagePath)

Get the list of parent page resources for a page

Parameters:

pagePath - the path of the page

Returns:

The list of parent page resources

getPageResources

java.util.List<PageResource> getPageResources(java.util.List<java.lang.String> pagePaths)

Gets the list of page resources for the list of page paths.

Parameters:

pagePaths - the list page paths

Returns:

the list of page resources

getPageDefAttributes

PageDef getPageDefAttributes(java.lang.String pagePath)

Gets a page's metadata defined in the page definition.

Parameters:

pagePath - path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getPage

PageDef getPage(java.lang.String pagePath)

Gets a page by its name by full path.

Parameters:

pagePath - the path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getDynamicMappingPage

PageDef getDynamicMappingPage(java.lang.String pagePath)

Gets a page which uses dynamic page mapping by its full path

Parameters:

pagePath - the path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getPageInScope

PageDef getPageInScope(java.lang.String pagePath)

Gets a page by its name with full path in the current scope.

Parameters:

pagePath - the path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getPageInBusinessRolePages

PageDef getPageInBusinessRolePages(java.lang.String pagePath)

Gets a page by its name with full path from the business pages

Parameters:

pagePath - the path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getPageByName

PageDef getPageByName(java.lang.String pageName)

Gets a page by its name.

Parameters:

pageName - the name of the page

Returns:

the page. If a page with specified name does not exist, returns null

getPageByViewID

PageDef getPageByViewID(java.lang.String pageViewID)

Gets a page by its full path.

Parameters:

pageViewID - the path of the page

Returns:

the page. If a page with specified path does not exist, returns null

getPageByContentMRef

PageDef getPageByContentMRef(java.lang.String contentMRef)

Gets a page by its full path.

Parameters:

ContentMRef - the path of the page.

Returns:

the page. If a page with specified path does not exist, returns null

getPageDefDocumentForUpdate

org.w3c.dom.Document getPageDefDocumentForUpdate(java.lang.String pagePath)

Gets a page's page definition document for updating.

Parameters:

pagePath - the path of the jspx page

Returns:

the page definition file. If the file is not found, returns null.

getSubFolders

@Deprecated
java.util.List<java.lang.String> getSubFolders(java.lang.String path,
                                                          int level)

Deprecated.

Gets a list of the sub folders of a path. Not that the sub folder doe not contain trailing "/"

Parameters:

path - the path to start search

level - the level of the sub folders

Returns:

the list of the sub folders

getPageStyleSiteResources

java.util.List<TemplateDef> getPageStyleSiteResources()

Gets page styles from the generic site resources.

Returns:

the list of page styles

isPageStyleAvailable

boolean isPageStyleAvailable(java.lang.String pageStyleName)

Checks if a page style is available

Parameters:

pageStyleName - the full path of the page style

Returns:

true if the page style exists and is not hidden. Otherwise returns false

isPageNameUnique

boolean isPageNameUnique(java.lang.String scopeName,
                         java.lang.String pageName)

Checks if a page name is unique within a scope.

Parameters:

scopeName - the name of the scope

pageName - the name to check

createPage

PageDef createPage(java.lang.String pageType,
                   java.lang.String nameFormat,
                   java.lang.String title,
                   java.lang.String pageTemplate,
                   java.lang.String pageTemplatePath,
                   java.lang.String cssStyle,
                   java.lang.String schemeBGImage,
                   java.lang.String schemeBGColor)
                   throws DuplicateNameException,
                          InvalidNameException,
                          LockUnavailableException

Creates a page in the target location. Callers invalidate cached objects after the operation is performed.

Parameters:

pageType - GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGE

nameFormat - name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.

title - title of the page

pageTemplate - template used for the page

pageTemplatePath - path for the page template

cssStyle - the css file for this page

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef object of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page operation is in progress

createPage

PageDef createPage(java.lang.String pageType,
                   java.lang.String nameFormat,
                   java.lang.String title,
                   java.lang.String pageTemplate,
                   java.lang.String pageTemplatePath,
                   java.lang.String ADFTemplateViewID,
                   java.lang.String cssStyle,
                   java.lang.String schemeBGImage,
                   java.lang.String schemeBGColor)
                   throws DuplicateNameException,
                          InvalidNameException,
                          LockUnavailableException

Creates a page in the target location. Callers invalidate cached objects after the operation is performed.

Parameters:

pageType - GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGE

nameFormat - name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.

title - title of the page

pageTemplate - template used for the page

pageTemplatePath - path for the page style

ADFTemplateViewID - viewID of the ADF page template

cssStyle - the css file for this page

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef object of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page operation is in progress

createTaskflow

PageDef createTaskflow(java.lang.String nameFormat,
                       java.lang.String title,
                       java.lang.String pageTemplate,
                       java.lang.String pageTemplatePath,
                       java.lang.String cssStyle,
                       java.lang.String schemeBGImage,
                       java.lang.String schemeBGColor)
                       throws DuplicateNameException,
                              InvalidNameException,
                              LockUnavailableException

Creates a taskflow in the target location.

Parameters:

nameFormat - name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.

title - title of the taskflow

pageTemplate - template used for the taskflow

pageTemplatePath - path for the taskflow template

cssStyle - the css file for this taskflow

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef object of the newly created taskflow

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page/taskflow operation is in progress

createTaskflowWithoutFlush

PageDef createTaskflowWithoutFlush(java.lang.String nameFormat,
                                   java.lang.String title,
                                   java.lang.String pageTemplate,
                                   java.lang.String pageTemplatePath,
                                   java.lang.String cssStyle,
                                   java.lang.String schemeBGImage,
                                   java.lang.String schemeBGColor)
                                   throws DuplicateNameException,
                                          InvalidNameException,
                                          LockUnavailableException

Creates a taskflow in the target location without flushing

Parameters:

nameFormat - name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.

title - title of the taskflow

pageTemplate - template used for the taskflow

pageTemplatePath - path for the taskflow template

cssStyle - the css file for this taskflow

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef object of the newly created taskflow

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page/taskflow operation is in progress

createTaskflow

PageDef createTaskflow(java.lang.String nameFormat,
                       java.lang.String title,
                       java.lang.String pageTemplate,
                       java.lang.String pageTemplatePath,
                       java.lang.String ADFTemplateViewID,
                       java.lang.String cssStyle,
                       java.lang.String schemeBGImage,
                       java.lang.String schemeBGColor)
                       throws DuplicateNameException,
                              InvalidNameException,
                              LockUnavailableException

Creates a taskflow in the target location.

Parameters:

nameFormat - name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.

title - title of the taskflow

pageTemplate - template used for the taskflow

pageTemplatePath - path for the taskflow template

ADFTemplateViewID - viewID of the ADF page template

cssStyle - the css file for this taskflow

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef of the newly created taskflow

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page/taskflow operation is in progress

createPage

PageDef createPage(java.lang.String pageType,
                   java.lang.String nameFormat,
                   java.lang.String title,
                   java.lang.String pageTemplate,
                   java.lang.String pageTemplatePath,
                   java.lang.String contentMRef,
                   java.lang.String viewID,
                   java.lang.String cssStyle,
                   java.lang.String schemeBGImage,
                   java.lang.String schemeBGColor)
                   throws DuplicateNameException,
                          InvalidNameException,
                          LockUnavailableException

Creates a page in the target location using the specified contentMRef. Callers invalidate cached objects after the operation is performed.

Parameters:

pageType - GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGE

nameFormat - name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.

title - title of the page

pageTemplate - template used for the page

pageTemplatePath - path for the page template

contentMRef - the uri used to navigate to this page

viewID - the view Activity id associated with the page

cssStyle - the css file for this page

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the custom scheme

Returns:

the PageDef of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page operation is in progress

createHierarchyPage

PageDef createHierarchyPage(java.lang.String parentPagePath,
                            java.lang.String nameFormat,
                            java.lang.String title,
                            java.lang.String pageStylePath,
                            java.lang.String pageTemplatePath,
                            java.lang.String createAfterPagePath)
                            throws DuplicateNameException,
                                   InvalidNameException,
                                   LockUnavailableException

Creates a sub page.

Parameters:

parentPagePath - the ful path of the parent page

nameFormat - name format of the page, e.g. Page{0}.jspx

title - title of the page

pageStylePath - the full path for the page style

pageTemplatePath - the full path for the page template

createAfterPagePath - the path of the page which the newly created page will follow. If the path is not specified, the new page is added to the end.

Returns:

the PageDef of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for create.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page operation is in progress

createPageMetadata

PageDef createPageMetadata(java.lang.String path,
                           java.lang.String title,
                           java.lang.String mRef,
                           java.lang.Boolean hidden,
                           java.lang.Boolean shared)
                           throws DuplicateNameException

Creates the page metadata in the target location specified by the path. This function creates the metadata file if it does not already exist under the specified path Callers invalidate cached objects after the operation is performed.

Parameters:

path - MDS path for the pages

mRef - Absolute path for the page starting from the MDS root

hidden - Flag which indicates if the page is shown in the application tab.

shared - Flag which indicates if the page does not belong to this scope

Returns:

the PageDef of the newly created page

Throws:

DuplicateNameException - If the page with the same name alredy exists.

createPageMetadataInBase

PageDef createPageMetadataInBase(java.lang.String path,
                                 java.lang.String title,
                                 java.lang.String mRef,
                                 java.lang.Boolean hidden,
                                 java.lang.Boolean shared)
                                 throws DuplicateNameException

Creates the page metadata in the target location specified by the path. This function will create the metadata file if it doesnt already exist under the specified path Callers invalidate cached objects after the operation is performed.

Parameters:

path - MDS path for the pages

mRef - absolute path for the page starting from the MDS root

hidden - flag that indicates if the page is shown in the application tab.

shared - flag that indicates if the page does not belong to this scope

Returns:

the PageDef of the newly created page

Throws:

DuplicateNameException - if the page with the same name already exists.

createEmptyMetadata

void createEmptyMetadata(java.lang.String path)
                         throws DuplicateNameException

Creates an empty page.xml file under the path.

Parameters:

path - MDS path for the pages.xml

Throws:

DuplicateNameException - if the pages.xml file already exists under the path

addPageEntry

PageDef addPageEntry(java.lang.String grantee,
                     java.lang.String pagepath,
                     java.lang.String title,
                     boolean hidden,
                     boolean shared)

Creates an entry of the page in pages.xml for a user or role.

Parameters:

grantee - the name of the user or role

pagepath - the page path

pagepath - the page title

hidden - flag

shared - flag

Returns:

the PageDef of the page. If the page does not exist, returns null.

removePageEntry

void removePageEntry(java.lang.String grantee,
                     java.lang.String pagepath)

Removes the entry of the page from the pages.xml file for a user or role.

Parameters:

grantee - the name of the user or role

pagepath - the page path

copyPage

PageDef copyPage(java.lang.String srcPage,
                 java.lang.String srcPath,
                 java.lang.String destPageNameFormat,
                 java.lang.String destPath,
                 java.lang.String destPageTitle)
                 throws DuplicateNameException,
                        InvalidNameException,
                        LockUnavailableException

Copies a page with name and destination path.

Parameters:

srcPage - name of the page to be copied, it can contain subpath such as users/UserA/page1.jspx.

srcPath - path for the page to be copied over.

destPageNameFormat - name format of the page to be created in the destination path. It can contain subpath such as users/UserB/page1.jspx.

destPath - destination path for creating the new page

destPageTitle - the title for the destination page

Returns:

the PageDef of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for copy.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException - another page operation is in progress

copyPageForGroupSpace

PageDef copyPageForGroupSpace(java.lang.String srcPage,
                              java.lang.String srcPath,
                              java.lang.String destPageNameFormat,
                              java.lang.String destPath,
                              java.lang.String destPageTitle)
                              throws DuplicateNameException,
                                     InvalidNameException

Copies a page with name and destination path a group space is provisioned.

Parameters:

srcPage - name of the page to be copied, it can contain subpath such as users/UserA/page1.jspx.

srcPath - path for the page to be copied over.

destPageNameFormat - name format of the page to be created in the destination path. It can contain subpath such as users/UserB/page1.jspx.

destPath - destination path for creating the new page

destPageTitle - the title for the destination page

Returns:

the PageDef of the newly created page

Throws:

InvalidNameException - if the name supplied cannot be used for copy.

DuplicateNameException - if the page with the same name alredy exists.

copyPage

PageDef copyPage(java.lang.String srcPage,
                 java.lang.String srcPath,
                 java.lang.String parentPagePath,
                 java.lang.String destPageNameFormat,
                 java.lang.String destPath,
                 java.lang.String destPageTitle,
                 java.lang.String copyAfterPagePath)
                 throws DuplicateNameException,
                        InvalidNameException,
                        LockUnavailableException

Copies a page with name and destination path under a parent page.

Parameters:

srcPage - name of the page to be copied, it can contain subpath such as users/UserA/page1.jspx.

srcPath - path for the page to be copied over.

parentPagePath - path of the parent page

destPageNameFormat - aame format of the page to be created in the destination path. It can contain subpath such as users/UserB/page1.jspx.

destPath - destination path for creating the new page

destPageTitle - the title for the destination page

copyAfterPagePath - the path of the page which the newly copied page will follow. If the path is not specified, the new page is added to the end

Returns:

the PageDef of the newly copied page

Throws:

InvalidNameException - if the name supplied cannot be used for copy.

DuplicateNameException - if the page with the same name alredy exists.

LockUnavailableException

movePage

PageDef movePage(java.lang.String pagePath,
                 java.lang.String parentPagePath)

Moves page under a new parent.

Parameters:

pagePath - the path of the page to be moved.

parentPagePath - the path of the new parent page

Returns:

the PageDef of the page under the new parent

sequencePageBefore

void sequencePageBefore(java.lang.String pagePath,
                        java.lang.String beforePagePath)

Sequences page before another page.

Parameters:

pagePath - the path of the page to be moved

beforePagePath - the path of the page before which the page will be moved

sequencePageAfter

void sequencePageAfter(java.lang.String pagePath,
                       java.lang.String afterPagePath)

Sequences page after another page.

Parameters:

pagePath - the path of the page to be moved

afterPagePath - the path of the page after which the page will be moved

sequencePageFront

void sequencePageFront(java.lang.String pagePath)

Sequences the page on the top of the list.

Parameters:

pagePath - the path of the page to be moved

sequencePageEnd

void sequencePageEnd(java.lang.String pagePath)

Sequences page to the end in the list.

Parameters:

pagePath - the path of the page to be moved

setPageTitle

void setPageTitle(java.lang.String pagepath,
                  java.lang.String title)
                  throws InvalidNameException,
                         ObjectChangedException,
                         LockUnavailableException,
                         oracle.webcenter.framework.translations.exception.TranslationsException

Updates the name of the page

Parameters:

pagepath - the page path

title - the new page name

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

InvalidNameException

oracle.webcenter.framework.translations.exception.TranslationsException

hidePage

void hidePage(java.lang.String pagepath)
              throws ObjectChangedException,
                     LockUnavailableException

Hides a page in the scope.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

hidePageInBusinessRolePages

void hidePageInBusinessRolePages(java.lang.String pagepath)
                                 throws ObjectChangedException,
                                        LockUnavailableException

Hides a page in the business pages.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

hidePage

void hidePage(java.lang.String pagepath,
              java.lang.String parentPath)
              throws ObjectChangedException,
                     LockUnavailableException

Hides a page in the hierarchy.

Parameters:

page - the page definition to be updated

parentPath - the path to the pages.xml

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

showPage

void showPage(java.lang.String pagepath)
              throws ObjectChangedException,
                     LockUnavailableException

Shows a page in the scope.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

showPageInBusinessRolePages

void showPageInBusinessRolePages(java.lang.String pagepath)
                                 throws ObjectChangedException,
                                        LockUnavailableException

Shows a page in the business pages.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

showPage

void showPage(java.lang.String pagepath,
              java.lang.String parentPath)
              throws ObjectChangedException,
                     LockUnavailableException

Shows a page in the hierarchy.

Parameters:

page - the page definition to be updated

parentPath - the path to the pages.xml

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

LockUnavailableException - another page operation is in progress

updatePageDefAttributes

void updatePageDefAttributes(PageDef page)
                             throws InvalidNameException,
                                    ObjectChangedException,
                                    LockUnavailableException

Updates the page attributes in page definition file and commits changes based on the specified page. Callers invalidate cached objects after the operation is performed.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

InvalidNameException - if the name supplied cannot be used for update.

LockUnavailableException - another page operation is in progress

updatePageDefBaseAttributes

void updatePageDefBaseAttributes(PageDef page)
                                 throws InvalidNameException,
                                        ObjectChangedException,
                                        LockUnavailableException

Updates the page attributes in the base page definition file and commits changes based on the specified page. Callers invalidate cached objects after the operation is performed.

Parameters:

page - the page definition to be updated

Throws:

ObjectChangedException - if the page has changed since it was last retrieved.

InvalidNameException - if the name supplied cannot be used for update.

LockUnavailableException - another page operation is in progress

setPageScheme

void setPageScheme(java.lang.String pagepath,
                   java.lang.String schemeName,
                   java.lang.String schemeBGImage,
                   java.lang.String schemeBGColor)

Updates the page's scheme properties in the jspx page.

Parameters:

pagepath - the path of the page

schemeName - the CSS for this page

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the scheme

setPageScheme

void setPageScheme(java.lang.String pagepath,
                   java.lang.String schemeName,
                   java.lang.String schemeBGImage,
                   java.lang.String schemeBGColor,
                   java.lang.String otherCSS)

Updates the page's scheme properties in the jspx page

Parameters:

pagepath - the path of the page

schemeName - the CSS for this page

schemeBGImage - the background image for the custom scheme

schemeBGColor - the background color for the scheme

otherCSS - other CSS attributes

getPageScheme

oracle.webcenter.page.model.PageSchemeDef getPageScheme(java.lang.String pagepath)

Gets the page's scheme properties in the jspx page

Parameters:

pagepath - the path of the page

Returns:

the PageSchemeDef object which contains the scheme properties

deletePage

void deletePage(PageDef page)
                throws ObjectChangedException,
                       LockUnavailableException

Deletes a page. Callers invalidate cached objects after the operation is performed.

Parameters:

page - the page to be deleted.

Throws:

ObjectChangedException - if the object has changed since it was last retrieved, and therefore the page cannot be deleted.

LockUnavailableException - another page operation is in progress

deletePage

void deletePage(java.lang.String pagePath)
                throws ObjectChangedException,
                       LockUnavailableException

Deletes a page. Callers invalidate cached objects after the operation is performed.

Parameters:

pagePath - the page to be deleted.

Throws:

ObjectChangedException - if the object has changed since it was last retrieved, and therefore the page cannot be deleted.

LockUnavailableException - another page operation is in progress

deletePageForGroupSpace

void deletePageForGroupSpace(PageDef page)

Deletes a page when a Space is unprovisioned. Callers invalidate cached objects after the operation is performed.

Parameters:

page - the page to be deleted.

deletePageMetadata

void deletePageMetadata(PageDef page)
                        throws ObjectChangedException

Deletes a page metadata from the pages.xml file. Callers invalidate cached objects after the operation is performed.

Parameters:

page - the page to be deleted

Throws:

ObjectChangedException - if the object has changed since it was last retrieved, and therefore the delete operation cannot be performed.

deletePageMetadata

void deletePageMetadata(java.lang.String pageMetadataPath,
                        PageDef page)
                        throws ObjectChangedException

Deletes a page metadata from the given pages.xml file. Callers invalidate cached objects after the operation is performed.

Parameters:

pageMetadataPath - the path of the pages.xml in which the entry of the page is residing which needs to be removed

page - the page to be deleted

Throws:

ObjectChangedException - if the object has changed since it was last retrieved, and therefore the delete operation cannot be performed.

deleteTaskflow

void deleteTaskflow(java.lang.String taskflowPath)
                    throws ObjectChangedException,
                           LockUnavailableException

Deletes a task flow.

Parameters:

taskflowPath - the path of the taskflow to be deleted.

Throws:

ObjectChangedException - if the object has changed since it was last retrieved, and therefore the task flow cannot be deleted.

LockUnavailableException - another operation is in progress

moveAfterPage

void moveAfterPage(java.lang.String pagePath,
                   java.lang.String afterPagePath)
                   throws LockUnavailableException

Moves a page after the specified page.

Parameters:

pagePath - the page path

afterPagePath - the path of the page after which this page will be moved

Throws:

LockUnavailableException - another page operation is in progress

moveBeforePage

void moveBeforePage(java.lang.String pagePath,
                    java.lang.String beforePagePath)
                    throws LockUnavailableException

Moves a page before the specified page

Parameters:

pagePath - the page path

beforePagePath - the path of the page before which this will be moved

Throws:

LockUnavailableException - another page operation is in progress

changePagePermission

void changePagePermission(java.lang.String servicePermission,
                          java.lang.String pagePath,
                          java.lang.Boolean invalidateBindings)

Changes global permissions to custom page permissions and vice versa.

Parameters:

servicePermission - name of the permission class to be used.

pagePath - complete path for the page including the page name.

invalidateBindings - indicates if binding context needs to be invalidated after changing the permission metadata for the page.

getPagePermission

java.lang.String getPagePermission(java.lang.String pagePath)

Gets the permission class associated with the page specified by the page path.

Parameters:

pagePath - the complete path of the page for which the permission class needs to be determined.

Returns:

the permission class defined for the page.

getPageSecurityTarget

java.lang.String getPageSecurityTarget(java.lang.String pagePath)

Gets the page security target from the page specified by the page path.

Parameters:

pagePath - the complete path of the page for which the security target needs to be determined.

Returns:

the security target defined for the page.

grantPagePermission

void grantPagePermission(java.lang.String pagePath,
                         java.lang.String granteeName,
                         java.lang.String permissions)

Grants page permission to the grantee.

Parameters:

pagePath - complete path for the page including the page name

granteeName - the grantee name such as monty, authenticated-role

permissions - the permissions to grant. It contains all permissions delimited by coma, for example grant,edit,customize,personalize,view

revokePagePermission

void revokePagePermission(java.lang.String pagePath,
                          java.lang.String granteeName)

Revokes page permission from the grantee.

Parameters:

pagePath - complete path for the page including the page name

granteeName - the grantee name such as monty, authenticated-role

saveChanges

void saveChanges()
                 throws ObjectChangedException

Persists the changes made in the current scope in the repository.

Throws:

ObjectChangedException - if the object has changed since it was last retrieved.

deletePagePersonalization

void deletePagePersonalization(java.lang.String pagePath)

Deletes the customization layer and any translation(s) of the page. The customization class (name and value) will be obtained from the MDS session defined for the page service. Callers must create the correct MDS session, for example UserCC before use this API.

getPortletIds

java.lang.String[] getPortletIds(java.lang.String pagePath)

Gets the portlet instance IDs on a page

Parameters:

pagePath - the page path

Returns:

the array of portlet instance IDs

isReadOnly

boolean isReadOnly(java.lang.String path)

Gets read-only flag set for the scope.

Parameters:

path - the path for the scope

Returns:

true if scope is read-only. Otherwise false</false>

setReadOnly

void setReadOnly(boolean readOnly,
                 java.lang.String path)

Set read-only flag for the scope. Subsequently no changes can be made to the scope.

Parameters:

readOnly - flag to be set

path - path for the scope

copyPagesSequence

void copyPagesSequence(java.lang.String srcPath,
                       java.lang.String destPath)

Copies the page sequence of a scope to another scope. The page sequence of the destination scope is updated if the sequence of the source scope is fewer.

Parameters:

srcPath - path for the source scope

destPath - path for the destination scope

invalidateScopeCache

void invalidateScopeCache()

Invalidate all data for the current scope.

invalidateScopeCache

void invalidateScopeCache(oracle.webcenter.framework.service.Scope scope)

Invalidate all data for the specified scope.

Parameters:

scope - the scope

invalidateScopeUserCache

void invalidateScopeUserCache(java.lang.String userName)

Invalidates all cache objects for a user in the current scope.

Parameters:

userName - the user name

invalidateUserCache

void invalidateUserCache(java.lang.String userName)

Invalidates all cache objects for a user.

Parameters:

userName - the user name

getTemplates

@Deprecated
java.util.List<TemplateDef> getTemplates(java.lang.String tempFile)

Deprecated.

Gets all page styles that are not for a Space.

Parameters:

tempFile - the template file name

getGroupSpaceTemplates

@Deprecated
java.util.List<TemplateDef> getGroupSpaceTemplates(java.lang.String tempFile)

Deprecated.

Gets all page styles that are used for a Space.

getSchemes

@Deprecated
java.util.List<SchemeDef> getSchemes()

Deprecated.

Gets all page schemes.

getPSSchemes

@Deprecated
java.util.List<SchemeDef> getPSSchemes()

Deprecated.

Gets all page schemes in the page service.

hasDeleteGroupSpaceLock

boolean hasDeleteGroupSpaceLock(java.lang.String path)

Obtains MDS lock to delete a Space.

Parameters:

path - path of this Space

hasCopyGroupSpaceLock

boolean hasCopyGroupSpaceLock(java.lang.String sourceSpacePath)

Obtains MDS lock to copy a Space.

Parameters:

path - path of the Space

wireTaskFlows

@Deprecated
void wireTaskFlows(java.lang.String fromTaskFlowId,
                              java.lang.String fromTaskFlowDefId,
                              java.lang.String toTaskFlowId,
                              java.lang.String toTaskFlowDefId,
                              java.lang.String fromTaskFlowAction,
                              java.lang.String toTaskFlowAction)

Deprecated.

Wires two task flows. This method seeds metadata in the task flow definition file for both task flows to navigate from the source task flow to the target task flow and vice versa.

Parameters:

fromTaskFlowId - the task flow id of the source task flow, e.g. /WEB-INF/dept.xml

fromTaskFlowDefId - the task flow definition id of the source task flow, e.g. dept

toTaskFlowId - the task flow id of the target task flow, e.g. /WEB-INF/emp.xml

toTaskFlowDefId - the task flow definition id of the target task flow, e.g. emp

fromTaskFlowAction - the action on the source task flow to go to the target task flow, e.g. showemps

toTaskFlowAction - the action on the target task flow to go back to the source task flow, e.g. saveclose

Skip navigation links