|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageService
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 |
---|
void setScope(java.lang.String scope)
scope
- the current scopejava.lang.String getScope()
boolean metadataObjectExists(java.lang.String path)
path
- the MDS path of the objectjava.util.List<PageDef> getAllPages()
java.util.List<PageDef> getAllPagesNoPermission()
java.util.List<PageDef> getPageList()
java.util.List<PageDef> getPageList(java.lang.String path)
path
- the pathjava.util.List<PageDef> getBusinessRolePages()
java.util.List<PageDef> getPersonalPages()
java.util.List<PageDef> getAllPagesForAdmin()
java.util.List<PageDef> getPersonalPages(java.lang.String userIdentifier)
java.util.List<java.lang.String> getAllPersonalPageOwners()
java.util.List<PageDef> getCachedPersonalPages()
java.util.List<PageDef> getPageHierarchy(java.lang.String parentPagePath)
parentPagePath
- the path of the parent page. If it is null or a scope name, get the top level pages of this scope.java.util.List<PageDef> getAllChildren(java.lang.String parentPagePath)
parentPagePath
- the path of the parent page.java.util.List<PageDef> searchPageHierarchy(java.lang.String parenPagePath, java.lang.String searchString)
parenPagePath
- the path of the parent page. It can be a scope name. If it is null, the current scope is usedjava.util.List<PageDef> searchChildPages(java.lang.String parentPagePath, java.lang.String searchString)
parenPagePath
- the path of the parent page. It can be a scope name. If it is null, the current scope is usedPageDef getParentPage(java.lang.String pagePath)
pagePath
- the path of the pagePageDef getHierarchyPage(java.lang.String pagePath)
pagePath
- the path of the pagejava.util.List<PageDef> getParentHierarchy(java.lang.String parenPagePath)
parenPagePath
- the path of the parent page. It can be a scope name. If it is null, the current scope is usedjava.util.List<PageResource> getParentResourceHierarchy(java.lang.String pagePath)
pagePath
- the path of the pagejava.util.List<PageResource> getPageResources(java.util.List<java.lang.String> pagePaths)
pagePaths
- the list page pathsPageDef getPageDefAttributes(java.lang.String pagePath)
pagePath
- path of the pagePageDef getPage(java.lang.String pagePath)
pagePath
- the path of the pagePageDef getDynamicMappingPage(java.lang.String pagePath)
pagePath
- the path of the pagePageDef getPageInScope(java.lang.String pagePath)
pagePath
- the path of the pagePageDef getPageInBusinessRolePages(java.lang.String pagePath)
pagePath
- the path of the pagePageDef getPageByName(java.lang.String pageName)
pageName
- the name of the pagePageDef getPageByViewID(java.lang.String pageViewID)
pageViewID
- the path of the pagePageDef getPageByContentMRef(java.lang.String contentMRef)
ContentMRef
- the path of the page.org.w3c.dom.Document getPageDefDocumentForUpdate(java.lang.String pagePath)
pagePath
- the path of the jspx page
@Deprecated
java.util.List<java.lang.String> getSubFolders(java.lang.String path,
int level)
path
- the path to start searchlevel
- the level of the sub foldersjava.util.List<TemplateDef> getPageStyleSiteResources()
boolean isPageStyleAvailable(java.lang.String pageStyleName)
pageStyleName
- the full path of the page styleboolean isPageNameUnique(java.lang.String scopeName, java.lang.String pageName)
scopeName
- the name of the scopepageName
- the name to checkPageDef 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
pageType
- GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGEnameFormat
- name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.title
- title of the pagepageTemplate
- template used for the pagepageTemplatePath
- path for the page templatecssStyle
- the css file for this pageschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
pageType
- GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGEnameFormat
- name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.title
- title of the pagepageTemplate
- template used for the pagepageTemplatePath
- path for the page styleADFTemplateViewID
- viewID of the ADF page templatecssStyle
- the css file for this pageschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
nameFormat
- name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.title
- title of the taskflowpageTemplate
- template used for the taskflowpageTemplatePath
- path for the taskflow templatecssStyle
- the css file for this taskflowschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
nameFormat
- name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.title
- title of the taskflowpageTemplate
- template used for the taskflowpageTemplatePath
- path for the taskflow templatecssStyle
- the css file for this taskflowschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
nameFormat
- name format of the taskflow, it can contain subpath such as users/UserA/taskflow{0}.jspx.title
- title of the taskflowpageTemplate
- template used for the taskflowpageTemplatePath
- path for the taskflow templateADFTemplateViewID
- viewID of the ADF page templatecssStyle
- the css file for this taskflowschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
pageType
- GROUP_SPACE_PAGE, PERSONAL_USER_PAGE or BUSINESS_ROLE_PAGEnameFormat
- name format of the page, it can contain subpath such as users/UserA/page{0}.jspx.title
- title of the pagepageTemplate
- template used for the pagepageTemplatePath
- path for the page templatecontentMRef
- the uri used to navigate to this pageviewID
- the view Activity id associated with the pagecssStyle
- the css file for this pageschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the custom schemeInvalidNameException
- 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 progressPageDef 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
parentPagePath
- the ful path of the parent pagenameFormat
- name format of the page, e.g. Page{0}.jspxtitle
- title of the pagepageStylePath
- the full path for the page stylepageTemplatePath
- the full path for the page templatecreateAfterPagePath
- 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.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 progressPageDef createPageMetadata(java.lang.String path, java.lang.String title, java.lang.String mRef, java.lang.Boolean hidden, java.lang.Boolean shared) throws DuplicateNameException
path
- MDS path for the pagesmRef
- Absolute path for the page starting from the MDS roothidden
- Flag which indicates if the page is shown in the application tab.shared
- Flag which indicates if the page does not belong to this scopeDuplicateNameException
- If the page with the same name alredy exists.PageDef createPageMetadataInBase(java.lang.String path, java.lang.String title, java.lang.String mRef, java.lang.Boolean hidden, java.lang.Boolean shared) throws DuplicateNameException
path
- MDS path for the pagesmRef
- absolute path for the page starting from the MDS roothidden
- flag that indicates if the page is shown in the application tab.shared
- flag that indicates if the page does not belong to this scopeDuplicateNameException
- if the page with the same name already exists.void createEmptyMetadata(java.lang.String path) throws DuplicateNameException
path
- MDS path for the pages.xmlDuplicateNameException
- if the pages.xml file already exists under the pathPageDef addPageEntry(java.lang.String grantee, java.lang.String pagepath, java.lang.String title, boolean hidden, boolean shared)
grantee
- the name of the user or rolepagepath
- the page pathpagepath
- the page titlehidden
- flagshared
- flagvoid removePageEntry(java.lang.String grantee, java.lang.String pagepath)
grantee
- the name of the user or rolepagepath
- the page pathPageDef 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
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 pagedestPageTitle
- the title for the destination pageInvalidNameException
- 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 progressPageDef copyPageForGroupSpace(java.lang.String srcPage, java.lang.String srcPath, java.lang.String destPageNameFormat, java.lang.String destPath, java.lang.String destPageTitle) throws DuplicateNameException, InvalidNameException
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 pagedestPageTitle
- the title for the destination pageInvalidNameException
- if the name supplied cannot be used for copy.DuplicateNameException
- if the page with the same name alredy exists.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
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 pagedestPageNameFormat
- 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 pagedestPageTitle
- the title for the destination pagecopyAfterPagePath
- 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 endInvalidNameException
- if the name supplied cannot be used for copy.DuplicateNameException
- if the page with the same name alredy exists.LockUnavailableException
PageDef movePage(java.lang.String pagePath, java.lang.String parentPagePath)
pagePath
- the path of the page to be moved.parentPagePath
- the path of the new parent pagevoid sequencePageBefore(java.lang.String pagePath, java.lang.String beforePagePath)
pagePath
- the path of the page to be movedbeforePagePath
- the path of the page before which the page will be movedvoid sequencePageAfter(java.lang.String pagePath, java.lang.String afterPagePath)
pagePath
- the path of the page to be movedafterPagePath
- the path of the page after which the page will be movedvoid sequencePageFront(java.lang.String pagePath)
pagePath
- the path of the page to be movedvoid sequencePageEnd(java.lang.String pagePath)
pagePath
- the path of the page to be movedvoid setPageTitle(java.lang.String pagepath, java.lang.String title) throws InvalidNameException, ObjectChangedException, LockUnavailableException, oracle.webcenter.framework.translations.exception.TranslationsException
pagepath
- the page pathtitle
- the new page nameObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressInvalidNameException
oracle.webcenter.framework.translations.exception.TranslationsException
void hidePage(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid hidePageInBusinessRolePages(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid hidePage(java.lang.String pagepath, java.lang.String parentPath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedparentPath
- the path to the pages.xmlObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid showPage(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid showPageInBusinessRolePages(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid showPage(java.lang.String pagepath, java.lang.String parentPath) throws ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedparentPath
- the path to the pages.xmlObjectChangedException
- if the page has changed since it was last retrieved.LockUnavailableException
- another page operation is in progressvoid updatePageDefAttributes(PageDef page) throws InvalidNameException, ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- 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 progressvoid updatePageDefBaseAttributes(PageDef page) throws InvalidNameException, ObjectChangedException, LockUnavailableException
page
- the page definition to be updatedObjectChangedException
- 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 progressvoid setPageScheme(java.lang.String pagepath, java.lang.String schemeName, java.lang.String schemeBGImage, java.lang.String schemeBGColor)
pagepath
- the path of the pageschemeName
- the CSS for this pageschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the schemevoid setPageScheme(java.lang.String pagepath, java.lang.String schemeName, java.lang.String schemeBGImage, java.lang.String schemeBGColor, java.lang.String otherCSS)
pagepath
- the path of the pageschemeName
- the CSS for this pageschemeBGImage
- the background image for the custom schemeschemeBGColor
- the background color for the schemeotherCSS
- other CSS attributesoracle.webcenter.page.model.PageSchemeDef getPageScheme(java.lang.String pagepath)
pagepath
- the path of the pagevoid deletePage(PageDef page) throws ObjectChangedException, LockUnavailableException
page
- the page to be deleted.ObjectChangedException
- if the object has changed since it was last retrieved, and therefore the page cannot be deleted.LockUnavailableException
- another page operation is in progressvoid deletePage(java.lang.String pagePath) throws ObjectChangedException, LockUnavailableException
pagePath
- the page to be deleted.ObjectChangedException
- if the object has changed since it was last retrieved, and therefore the page cannot be deleted.LockUnavailableException
- another page operation is in progressvoid deletePageForGroupSpace(PageDef page)
page
- the page to be deleted.void deletePageMetadata(PageDef page) throws ObjectChangedException
page
- the page to be deletedObjectChangedException
- if the object has changed since it was last retrieved, and therefore the delete operation cannot be performed.void deletePageMetadata(java.lang.String pageMetadataPath, PageDef page) throws ObjectChangedException
pageMetadataPath
- the path of the pages.xml in which the entry of the page is residing which needs to be removedpage
- the page to be deletedObjectChangedException
- if the object has changed since it was last retrieved, and therefore the delete operation cannot be performed.void deleteTaskflow(java.lang.String taskflowPath) throws ObjectChangedException, LockUnavailableException
taskflowPath
- the path of the taskflow to be deleted.ObjectChangedException
- if the object has changed since it was last retrieved, and therefore the task flow cannot be deleted.LockUnavailableException
- another operation is in progressvoid moveAfterPage(java.lang.String pagePath, java.lang.String afterPagePath) throws LockUnavailableException
pagePath
- the page pathafterPagePath
- the path of the page after which this page will be movedLockUnavailableException
- another page operation is in progressvoid moveBeforePage(java.lang.String pagePath, java.lang.String beforePagePath) throws LockUnavailableException
pagePath
- the page pathbeforePagePath
- the path of the page before which this will be movedLockUnavailableException
- another page operation is in progressvoid changePagePermission(java.lang.String servicePermission, java.lang.String pagePath, java.lang.Boolean invalidateBindings)
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.java.lang.String getPagePermission(java.lang.String pagePath)
pagePath
- the complete path of the page for which the permission class needs to be determined.java.lang.String getPageSecurityTarget(java.lang.String pagePath)
pagePath
- the complete path of the page for which the security target needs to be determined.void grantPagePermission(java.lang.String pagePath, java.lang.String granteeName, java.lang.String permissions)
pagePath
- complete path for the page including the page namegranteeName
- the grantee name such as monty, authenticated-rolepermissions
- the permissions to grant. It contains all permissions delimited by coma, for example grant,edit,customize,personalize,viewvoid revokePagePermission(java.lang.String pagePath, java.lang.String granteeName)
pagePath
- complete path for the page including the page namegranteeName
- the grantee name such as monty, authenticated-rolevoid saveChanges() throws ObjectChangedException
ObjectChangedException
- if the object has changed since it was last retrieved.void deletePagePersonalization(java.lang.String pagePath)
java.lang.String[] getPortletIds(java.lang.String pagePath)
pagePath
- the page pathboolean isReadOnly(java.lang.String path)
path
- the path for the scopetrue
if scope is read-only. Otherwise false</false>
void setReadOnly(boolean readOnly, java.lang.String path)
readOnly
- flag to be setpath
- path for the scopevoid copyPagesSequence(java.lang.String srcPath, java.lang.String destPath)
srcPath
- path for the source scopedestPath
- path for the destination scopevoid invalidateScopeCache()
void invalidateScopeCache(oracle.webcenter.framework.service.Scope scope)
scope
- the scopevoid invalidateScopeUserCache(java.lang.String userName)
userName
- the user namevoid invalidateUserCache(java.lang.String userName)
userName
- the user name
@Deprecated
java.util.List<TemplateDef> getTemplates(java.lang.String tempFile)
tempFile
- the template file name
@Deprecated
java.util.List<TemplateDef> getGroupSpaceTemplates(java.lang.String tempFile)
@Deprecated
java.util.List<SchemeDef> getSchemes()
@Deprecated
java.util.List<SchemeDef> getPSSchemes()
boolean hasDeleteGroupSpaceLock(java.lang.String path)
path
- path of this Spaceboolean hasCopyGroupSpaceLock(java.lang.String sourceSpacePath)
path
- path of the Space
@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)
fromTaskFlowId
- the task flow id of the source task flow, e.g. /WEB-INF/dept.xmlfromTaskFlowDefId
- the task flow definition id of the source task flow, e.g. depttoTaskFlowId
- the task flow id of the target task flow, e.g. /WEB-INF/emp.xmltoTaskFlowDefId
- the task flow definition id of the target task flow, e.g. empfromTaskFlowAction
- the action on the source task flow to go to the target task flow, e.g. showempstoTaskFlowAction
- the action on the target task flow to go back to the source task flow, e.g. saveclose
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |