|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
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) 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 |
---|
void setScope(java.lang.String scope)
scope
- the current scopejava.lang.String getScope()
java.util.List<PageDef> getAllPages()
java.util.List<PageDef> getAllPagesNoPermission()
java.util.List<PageDef> getPageList()
java.util.List<PageDef> getPageList(java.lang.String path)
java.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()
PageDef getPageDefAttributes(java.lang.String pagePath)
pagePath
- path of the page to getPageDef getPage(java.lang.String pagePath)
pagePath
- Name of the page to findPageDef getPageInScope(java.lang.String pagePath)
pagePath
- path of the page to findPageDef getPageByName(java.lang.String pageName)
pageName
- Name of the page to findPageDef getPageByViewID(java.lang.String pageViewID)
pageViewID
- viewID used for the page.PageDef getPageByContentMRef(java.lang.String contentMRef)
ContentMRef
- ContentMRef of the page.org.w3c.dom.Document getPageDefDocumentForUpdate(java.lang.String pagePath)
pagePath
- the page path of the jspx pagejava.util.List<java.lang.String> getSubFolders(java.lang.String path, int level)
path
- the path to start searchlevel
- the level of the sub folders to look forPageDef 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 update.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 templateADFTemplateViewID
- ADF page template viewIDcssStyle
- 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 update.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 update.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
- ADF page template viewIDcssStyle
- 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 update.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 update.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 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.void createEmptyMetadata(java.lang.String path) throws DuplicateNameException, PageServiceRuntimeException
path
- MDS path for the pages.xmlDuplicateNameException
- the pages.xml already exists under the pathPageServiceRuntimeException
PageDef 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 update.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 update.DuplicateNameException
- If the page with the same name alredy exists.void setPageTitle(java.lang.String pagepath, java.lang.String title) throws InvalidNameException, ObjectChangedException, LockUnavailableException
pagepath
- the page pathtitle
- the new page nameObjectChangedException
- If the page has changed since it was last retreived.LockUnavailableException
- Another page operation is in progressInvalidNameException
void hidePage(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- Page definition to be updatedObjectChangedException
- If the page has changed since it was last retreived.LockUnavailableException
- Another page operation is in progressvoid showPage(java.lang.String pagepath) throws ObjectChangedException, LockUnavailableException
page
- Page definition to be updatedObjectChangedException
- If the page has changed since it was last retreived.LockUnavailableException
- Another page operation is in progressvoid updatePageDefAttributes(PageDef page) throws InvalidNameException, ObjectChangedException, LockUnavailableException
page
- Page definition to be updatedObjectChangedException
- 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 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 schemePageSchemeDef 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 retreived, and delete cannot be done.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 retreived, and delete cannot be done.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 whose metadata will be deleted.ObjectChangedException
- If the object has changed since it was last retreived, and delete cannot be done.void deleteTaskflow(java.lang.String taskflowPath) throws ObjectChangedException, LockUnavailableException
taskflowPath
- The taskflow to be deleted.ObjectChangedException
- If the object has changed since it was last retreived, and delete cannot be done.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 to move afterLockUnavailableException
- 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 to move beforeLockUnavailableException
- 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 entire path for the page for which Permission class needs to be determined.java.lang.String getPageSecurityTarget(java.lang.String pagePath)
pagePath
- The entire path for the page for which 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 pemissions to grant. It contains all permissions delimited by coma, e.g. 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 retreived.void deletePagePersonalization(java.lang.String pagePath)
boolean isReadOnly(java.lang.String path)
path
- Path for the scopetrue>/code> if scope is read only.
false</false> otherwise.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 invalidateScopeUserCache(java.lang.String userName)
void invalidateUserCache(java.lang.String userName)
java.util.List<TemplateDef> getTemplates(java.lang.String tempFile)
tempFile
- the template file namejava.util.List<TemplateDef> getGroupSpaceTemplates(java.lang.String tempFile)
java.util.List<SchemeDef> getSchemes()
java.util.List<SchemeDef> getPSSchemes()
boolean hasDeleteGroupSpaceLock(java.lang.String path)
path
- path of this group spaceboolean hasCopyGroupSpaceLock(java.lang.String sourceSpacePath)
path
- path of the source space pathvoid 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 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |