|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PageInstanceControl
A custom control interface used to interact with PageInstances.
Method Summary | |
---|---|
void |
addPlaceableToPageInstance(com.bea.netuix.application.identifier.PlaceableDefinitionId placeableId,
int placeholder,
int position,
com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Adds a book or portlet definition to a page instance. |
com.bea.netuix.application.instance.PageInstance |
getPageInstance(com.bea.netuix.application.identifier.PageInstanceId id,
com.bea.portal.tools.common.ResourceContext context)
Gets a PageInstance object |
com.bea.netuix.application.view.PageView |
getPageView(com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Gets a deep immutable view of a page instance. |
boolean |
isPlaceholderLocked(int placeholder,
com.bea.netuix.application.identifier.PageInstanceId pageId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Returns true if the placeholder has an update security policy on it. |
void |
movePlaceable(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId,
int placeholder,
int position,
com.bea.netuix.application.identifier.PageInstanceId fromPageInstanceId,
com.bea.netuix.application.identifier.PageInstanceId toPageInstanceId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Moves a book or portlet to another page instance. |
void |
movePlaceableInPageInstance(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId,
int placeholder,
int position,
com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Moves a book or portlet to another placeholder in the same page instance. |
void |
removePlaceableFromPageInstance(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Removes a portlet or book from a page instance. |
void |
removePlaceholderLock(int placeholder,
com.bea.netuix.application.identifier.PageInstanceId pageId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Removes the update security policy on a placeholder. |
com.bea.netuix.application.identifier.PageInstanceId |
rename(String newTitle,
com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Rename the title of the page. |
void |
setPlaceholderLock(int placeholder,
com.bea.netuix.application.identifier.PageInstanceId pageId,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Creates an update secuity policy on a placholder. |
com.bea.netuix.application.identifier.PageInstanceId |
updatePageInstanceLayout(com.bea.netuix.application.identifier.LayoutDefinitionId layoutId,
com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Updates the page instance layout. |
com.bea.netuix.application.identifier.PageInstanceId |
updatePageInstanceTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId,
com.bea.netuix.application.identifier.PageInstanceId id,
String webApp,
com.bea.netuix.application.identifier.PortalPath portalPath,
com.bea.netuix.application.identifier.DesktopPath desktopPath,
com.bea.portal.tools.common.ResourceContext context)
Updates the page instance theme. |
Method Detail |
---|
com.bea.netuix.application.view.PageView getPageView(com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.instance.PageInstance getPageInstance(com.bea.netuix.application.identifier.PageInstanceId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
id
- the page instance IDcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.identifier.PageInstanceId updatePageInstanceLayout(com.bea.netuix.application.identifier.LayoutDefinitionId layoutId, com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
layoutId
- The id of the layout.id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.identifier.PageInstanceId updatePageInstanceTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId, com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
themeId
- The id of the theme.id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void addPlaceableToPageInstance(com.bea.netuix.application.identifier.PlaceableDefinitionId placeableId, int placeholder, int position, com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.IllegalDependencyException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
placeableId
- The id of the book or portlet definition to add.placeholder
- The placeholder to use.position
- The placeable position.id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.IllegalDependencyException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
void movePlaceableInPageInstance(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId, int placeholder, int position, com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.IllegalDependencyException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
placeableId
- The id of the book or portlet instance to move.placeholder
- The placeholder to use.position
- The placeable position.id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.IllegalDependencyException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
void movePlaceable(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId, int placeholder, int position, com.bea.netuix.application.identifier.PageInstanceId fromPageInstanceId, com.bea.netuix.application.identifier.PageInstanceId toPageInstanceId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.IllegalDependencyException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
placeableId
- The id of the book or portlet instance to move.placeholder
- The placeholder to use.position
- The placeable position.fromPageInstanceId
- the page instance ID to move fromtoPageInstanceId
- the page instance ID to move towebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.IllegalDependencyException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.identifier.PageInstanceId rename(String newTitle, com.bea.netuix.application.identifier.PageInstanceId id, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.netuix.application.exception.MissingDataException
newTitle
- the new title for the pageid
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.exception.MissingDataException
void removePlaceableFromPageInstance(com.bea.netuix.application.identifier.PlaceableInstanceId placeableId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
placeableId
- The id of the book or portlet instance to remove.webApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
boolean isPlaceholderLocked(int placeholder, com.bea.netuix.application.identifier.PageInstanceId pageId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
void setPlaceholderLock(int placeholder, com.bea.netuix.application.identifier.PageInstanceId pageId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.p13n.entitlements.common.PolicyCreateException, com.bea.p13n.entitlements.common.PolicyExistsException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.entitlements.common.PolicyCreateException
com.bea.p13n.entitlements.common.PolicyExistsException
void removePlaceholderLock(int placeholder, com.bea.netuix.application.identifier.PageInstanceId pageId, String webApp, com.bea.netuix.application.identifier.PortalPath portalPath, com.bea.netuix.application.identifier.DesktopPath desktopPath, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.p13n.entitlements.common.PolicyRemoveException, com.bea.p13n.entitlements.common.PolicyNotFoundException
placeholder
- The index of the placeholder on the page.pageId
- the ID of the pagewebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.entitlements.common.PolicyRemoveException
com.bea.p13n.entitlements.common.PolicyNotFoundException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |