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) Create 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) Change security metadata for a page from global permission to custom page permission and vice versa depending upon on the security mode.
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, destination path.
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, destination path when provision a group space.
void	copyPagesSequence(java.lang.String srcPath, java.lang.String destPath) Copy the page sequence of a scope to another scope.
void	createEmptyMetadata(java.lang.String path) Create an empty page.xml under the path
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.
void	deletePage(PageDef page) Deletes a page.
void	deletePage(java.lang.String pagePath) Deletes a page.
void	deletePageForGroupSpace(PageDef page) Deletes a page when unprovision a group space Callers are responsible of invalidating cached objects after the operation
void	deletePageMetadata(PageDef page) Deletes a page metadata from pages.xml.
void	deletePagePersonalization(java.lang.String pagePath) Delete the customization layer and any translation(s) of the page.
void	deleteTaskflow(java.lang.String taskflowPath) Deletes a task flow.
java.util.List<PageDef>	getAllPages() Get all the pages.
java.util.List<PageDef>	getAllPagesForAdmin() Get all pages for Admin which include all business role pages and all personal pages
java.util.List<PageDef>	getAllPagesNoPermission() Get all the pages bypassing the security checks.
java.util.List<java.lang.String>	getAllPersonalPageOwners() Get all user identifiers who own personal pages
java.util.List<PageDef>	getBusinessRolePages() Get all business role pages
java.util.List<PageDef>	getCachedPersonalPages() Get the list of pages from cache for the user in the personal space return The list of pages of a user
java.util.List<TemplateDef>	getGroupSpaceTemplates(java.lang.String tempFile) Get all templates which are used for group space
PageDef	getPage(java.lang.String pagePath) Get a page by page name with full path
PageDef	getPageByContentMRef(java.lang.String contentMRef) Get a page by ContentMRef within the current scope
PageDef	getPageByName(java.lang.String pageName) Get a page by name.
PageDef	getPageByViewID(java.lang.String pageViewID) Get a page by ViewID within the current scope
PageDef	getPageDefAttributes(java.lang.String pagePath) Get a page's metadata defined in pagedef
org.w3c.dom.Document	getPageDefDocumentForUpdate(java.lang.String pagePath) Get a page's pagedef document for updating The page is either created by Page Service using the dynamic page mapping or it has entry in the databinding cpx file.
PageDef	getPageInScope(java.lang.String pagePath) Get a page by page name with full path in the current scope
java.util.List<PageDef>	getPageList() Get all the pages the user can view
java.util.List<PageDef>	getPageList(java.lang.String path) Get all the pages can view
java.lang.String	getPagePermission(java.lang.String pagePath) Get the permission class associated with the page specified by the pagePath.
PageSchemeDef	getPageScheme(java.lang.String pagepath) Get the page's scheme properties in the jspx page
java.lang.String	getPageSecurityTarget(java.lang.String pagePath) Get the page security target from the page specified by the pagePath.
java.util.List<PageDef>	getPersonalPages() Get all personal pages
java.util.List<PageDef>	getPersonalPages(java.lang.String userIdentifier) Get all personal pages of a user
java.util.List<SchemeDef>	getPSSchemes() Get all page schems in the page service
java.util.List<SchemeDef>	getSchemes() Get all page schems
java.lang.String	getScope() Gets the current scope.
java.util.List<java.lang.String>	getSubFolders(java.lang.String path, int level) Get a list of the sub folders of a path.
java.util.List<TemplateDef>	getTemplates(java.lang.String tempFile) Get all templates which are not for group space
void	grantPagePermission(java.lang.String pagePath, java.lang.String granteeName, java.lang.String permissions) Grant ADF Page permission to the grantee
boolean	hasCopyGroupSpaceLock(java.lang.String sourceSpacePath) Obtain MDS lock to copy a group space
boolean	hasDeleteGroupSpaceLock(java.lang.String path) Obtain MDS lock to delete a group space
void	hidePage(java.lang.String pagepath) Hide a page
void	invalidateScopeCache() Invalidate all data for the current scope.
void	invalidateScopeUserCache(java.lang.String userName) Invalidate all cache objects for a user in the current scope
void	invalidateUserCache(java.lang.String userName) Invalidate all cache objects for a user
boolean	isReadOnly(java.lang.String path) Get read Only flag set for the scope.
void	moveAfterPage(java.lang.String pagePath, java.lang.String afterPagePath) Move a page after the specified page
void	moveBeforePage(java.lang.String pagePath, java.lang.String beforePagePath) Move a page before the specified page
void	removePageEntry(java.lang.String grantee, java.lang.String pagepath) Remove the entry of the page from pages.xml for a user or role
void	revokePagePermission(java.lang.String pagePath, java.lang.String granteeName) Revoke ADF Page permission from the grantee
void	saveChanges() Persists the changes made in the current scope in the repository.
void	setPageScheme(java.lang.String pagepath, java.lang.String schemeName, java.lang.String schemeBGImage, java.lang.String schemeBGColor) Update the page's scheme properties in the jspx page
void	setPageTitle(java.lang.String pagepath, java.lang.String title) Update page name for a 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) Show a page
void	updatePageDefAttributes(PageDef page) Updates the page attributes in pagedef 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) Wire two task flows This method seeds metadata in the task flow definition file for both task flows which is needed to navigate from the source task flow to the target task flow and return from the target task flow back to the source task flow.

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.

getAllPages

java.util.List<PageDef> getAllPages()

Get all the pages.

Returns:

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

getAllPagesNoPermission

java.util.List<PageDef> getAllPagesNoPermission()

Get all the pages bypassing the security checks. This is required because of the limitation that call to the API from MBean 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()

Get all the pages the user can view

Returns:

The list of all pages in the current scope which are not hidden

getPageList

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

Get all the pages can view

Returns:

The list of all pages under a specific path which are not hidden

getBusinessRolePages

java.util.List<PageDef> getBusinessRolePages()

Get all business role pages

Returns:

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

getPersonalPages

java.util.List<PageDef> getPersonalPages()

Get all personal pages

Returns:

The list of all personal pages regardless of the status.

getAllPagesForAdmin

java.util.List<PageDef> getAllPagesForAdmin()

Get all pages for Admin which include all business role pages and all personal pages

Returns:

The list of all personal pages regardless of the status.

getPersonalPages

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

Get all personal pages of a user

Returns:

The list of pages of a user

getAllPersonalPageOwners

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

Get all user identifiers who own personal pages

Returns:

The list of user identifiers

getCachedPersonalPages

java.util.List<PageDef> getCachedPersonalPages()

Get the list of pages from cache for the user in the personal space return The list of pages of a user

getPageDefAttributes

PageDef getPageDefAttributes(java.lang.String pagePath)

Get a page's metadata defined in pagedef

Parameters:

pagePath - path of the page to get

Returns:

page or null if page with specified path does not exist

getPage

PageDef getPage(java.lang.String pagePath)

Get a page by page name with full path

Parameters:

pagePath - Name of the page to find

Returns:

PageDef for the page based on the name specified or null if page with specified name does not exist.

getPageInScope

PageDef getPageInScope(java.lang.String pagePath)

Get a page by page name with full path in the current scope

Parameters:

pagePath - path of the page to find

Returns:

PageDef for the page based on the name specified or null if page with specified name does not exist.

getPageByName

PageDef getPageByName(java.lang.String pageName)

Get a page by name.

Parameters:

pageName - Name of the page to find

Returns:

PageDef for the page based on the name specified or null if page with specified name does not exist.

getPageByViewID

PageDef getPageByViewID(java.lang.String pageViewID)

Get a page by ViewID within the current scope

Parameters:

pageViewID - viewID used for the page.

Returns:

PageDef for the page based on the viewID specified or null if page with specified ViewID does not exist.

getPageByContentMRef

PageDef getPageByContentMRef(java.lang.String contentMRef)

Get a page by ContentMRef within the current scope

Parameters:

ContentMRef - ContentMRef of the page.

Returns:

PageDef for the page based on the ContentMRef specified or null if page with specified ContentMRef does not exist.

getPageDefDocumentForUpdate

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

Get a page's pagedef document for updating The page is either created by Page Service using the dynamic page mapping or it has entry in the databinding cpx file.

Parameters:

pagePath - the page path of the jspx page

Returns:

the Document of the pagedef. If the pagedef isn't found, null will be returned.

getSubFolders

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

Get a list of the sub folders of a path. The sun folder name doesn't contain trailing "/"

Parameters:

path - the path to start search

level - the level of the sub folders to look for

Returns:

the list of the sub folders

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 are responsible of invalidating cached objects after the operation

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 of the newly created page

Throws:

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

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 are responsible of invalidating cached objects after the operation

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

ADFTemplateViewID - ADF page template viewID

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 update.

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. Callers are responsible of invalidating cached objects after the operation

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 of the newly created taskflow

Throws:

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

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. Callers are responsible of invalidating cached objects after the operation

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 - ADF page template viewID

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 update.

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 are responsible of invalidating cached objects after the operation

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 update.

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 will create the metadata file if it doesnt already exist under the specified path Callers are responsible of invalidating cached objects after the operation

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 are responsible of invalidating cached objects after the operation

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.

createEmptyMetadata

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

Create an empty page.xml under the path

Parameters:

path - MDS path for the pages.xml

Throws:

DuplicateNameException - the pages.xml already exists under the path

PageServiceRuntimeException

addPageEntry

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

Create 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 doesn't exist, null will be returned

removePageEntry

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

Remove the entry of the page from pages.xml 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, 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 update.

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, destination path when provision a group space.

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 update.

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

setPageTitle

void setPageTitle(java.lang.String pagepath,
                  java.lang.String title)
                  throws InvalidNameException,
                         ObjectChangedException,
                         LockUnavailableException

Update page name for a page

Parameters:

pagepath - the page path

title - the new page name

Throws:

ObjectChangedException - If the page has changed since it was last retreived.

LockUnavailableException - Another page operation is in progress

InvalidNameException

hidePage

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

Hide a page

Parameters:

page - Page definition to be updated

Throws:

ObjectChangedException - If the page has changed since it was last retreived.

LockUnavailableException - Another page operation is in progress

showPage

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

Show a page

Parameters:

page - Page definition to be updated

Throws:

ObjectChangedException - If the page has changed since it was last retreived.

LockUnavailableException - Another page operation is in progress

updatePageDefAttributes

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

Updates the page attributes in pagedef file and commits changes based on the specified page. Callers are responsible of invalidating cached objects after the operation

Parameters:

page - Page definition to be updated

Throws:

ObjectChangedException - If the page has changed since it was last retreived.

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)

Update 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

getPageScheme

PageSchemeDef getPageScheme(java.lang.String pagepath)

Get 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 are responsible of invalidating cached objects after the operation

Parameters:

page - The page to be deleted.

Throws:

ObjectChangedException - If the object has changed since it was last retreived, and delete cannot be done.

LockUnavailableException - Another page operation is in progress

deletePage

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

Deletes a page. Callers are responsible of invalidating cached objects after the operation

Parameters:

pagePath - The page to be deleted.

Throws:

ObjectChangedException - If the object has changed since it was last retreived, and delete cannot be done.

LockUnavailableException - Another page operation is in progress

deletePageForGroupSpace

void deletePageForGroupSpace(PageDef page)

Deletes a page when unprovision a group space Callers are responsible of invalidating cached objects after the operation

Parameters:

page - The page to be deleted.

deletePageMetadata

void deletePageMetadata(PageDef page)
                        throws ObjectChangedException

Deletes a page metadata from pages.xml. Callers are responsible of invalidating cached objects after the operation

Parameters:

page - The page whose metadata will be deleted.

Throws:

ObjectChangedException - If the object has changed since it was last retreived, and delete cannot be done.

deleteTaskflow

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

Deletes a task flow.

Parameters:

taskflowPath - The taskflow to be deleted.

Throws:

ObjectChangedException - If the object has changed since it was last retreived, and delete cannot be done.

LockUnavailableException - Another operation is in progress

moveAfterPage

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

Move a page after the specified page

Parameters:

pagePath - the page path

afterPagePath - the path of the page to move after

Throws:

LockUnavailableException - Another page operation is in progress

moveBeforePage

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

Move a page before the specified page

Parameters:

pagePath - the page path

beforePagePath - the path of the page to move before

Throws:

LockUnavailableException - Another page operation is in progress

changePagePermission

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

Change security metadata for a page from global permission to custom page permission and vice versa depending upon on the security mode.

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)

Get the permission class associated with the page specified by the pagePath.

Parameters:

pagePath - The entire path for the page for which Permission class needs to be determined.

Returns:

Permission class defined for the page.

getPageSecurityTarget

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

Get the page security target from the page specified by the pagePath.

Parameters:

pagePath - The entire path for the page for which Security target needs to be determined.

Returns:

Security target defined for the page.

grantPagePermission

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

Grant ADF 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 pemissions to grant. It contains all permissions delimited by coma, e.g. grant,edit,customize,personalize,view

revokePagePermission

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

Revoke ADF 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 retreived.

deletePagePersonalization

void deletePagePersonalization(java.lang.String pagePath)

Delete 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 page service. Callers have to create the correct MDS session (e.g. UserCC) before use this API.

isReadOnly

boolean isReadOnly(java.lang.String path)

Get read Only flag set for the scope.

Parameters:

path - Path for the scope

Returns:

true>/code> if scope is read only. false</false> otherwise.

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)

Copy the page sequence of a scope to another scope. The page sequence of the destination scope won't be 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.

invalidateScopeUserCache

void invalidateScopeUserCache(java.lang.String userName)

Invalidate all cache objects for a user in the current scope

invalidateUserCache

void invalidateUserCache(java.lang.String userName)

Invalidate all cache objects for a user

getTemplates

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

Get all templates which are not for group space

Parameters:

tempFile - the template file name

getGroupSpaceTemplates

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

Get all templates which are used for group space

getSchemes

java.util.List<SchemeDef> getSchemes()

Get all page schems

getPSSchemes

java.util.List<SchemeDef> getPSSchemes()

Get all page schems in the page service

hasDeleteGroupSpaceLock

boolean hasDeleteGroupSpaceLock(java.lang.String path)

Obtain MDS lock to delete a group space

Parameters:

path - path of this group space

hasCopyGroupSpaceLock

boolean hasCopyGroupSpaceLock(java.lang.String sourceSpacePath)

Obtain MDS lock to copy a group space

Parameters:

path - path of the source space path

wireTaskFlows

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)

Wire two task flows This method seeds metadata in the task flow definition file for both task flows which is needed to navigate from the source task flow to the target task flow and return from the target task flow back to the source task flow.

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