|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface PageInstanceControl
A custom control interface used to interact with PageInstances.
Method Summary | |
---|---|
void |
addPlaceableToPageInstance(PlaceableDefinitionId placeableId,
int placeholder,
int position,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Adds a book or portlet definition to a page instance. |
PageInstance |
getPageInstance(PageInstanceId id,
ResourceContext context)
Gets a PageInstance object |
PageView |
getPageView(PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Gets a deep immutable view of a page instance. |
boolean |
isPlaceholderLocked(int placeholder,
PageInstanceId pageId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Returns true if the placeholder has an update security policy on it. |
void |
movePlaceable(PlaceableInstanceId placeableId,
int placeholder,
int position,
PageInstanceId fromPageInstanceId,
PageInstanceId toPageInstanceId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Moves a book or portlet to another page instance. |
void |
movePlaceableInPageInstance(PlaceableInstanceId placeableId,
int placeholder,
int position,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Moves a book or portlet to another placeholder in the same page instance. |
void |
removePlaceableFromPageInstance(PlaceableInstanceId placeableId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Removes a portlet or book from a page instance. |
void |
removePlaceholderLock(int placeholder,
PageInstanceId pageId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Removes the update security policy on a placeholder. |
PageInstanceId |
rename(String newTitle,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Rename the title of the page. |
void |
setPlaceholderLock(int placeholder,
PageInstanceId pageId,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Creates an update secuity policy on a placholder. |
PageInstanceId |
updatePageInstanceLayout(LayoutDefinitionId layoutId,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the page instance layout. |
PageInstanceId |
updatePageInstanceTheme(ThemeDefinitionId themeId,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
boolean isHidden,
ResourceContext context)
Updates the page instance theme. |
PageInstanceId |
updatePageInstanceTheme(ThemeDefinitionId themeId,
PageInstanceId id,
String webApp,
PortalPath portalPath,
DesktopPath desktopPath,
ResourceContext context)
Updates the page instance theme. |
Method Detail |
---|
PageView getPageView(PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException
id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource context
ToolsException
PageInstance getPageInstance(PageInstanceId id, ResourceContext context) throws ToolsException
id
- the page instance IDcontext
- the resource context
ToolsException
PageInstanceId updatePageInstanceLayout(LayoutDefinitionId layoutId, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, 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
ToolsException
NotEntitledException
ObjectNotFoundException
PageInstanceId updatePageInstanceTheme(ThemeDefinitionId themeId, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, 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
ToolsException
NotEntitledException
ObjectNotFoundException
PageInstanceId updatePageInstanceTheme(ThemeDefinitionId themeId, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, boolean isHidden, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
themeId
- The id of the theme.id
- the page instance IDwebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathisHidden
- is the page viewablecontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void addPlaceableToPageInstance(PlaceableDefinitionId placeableId, int placeholder, int position, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, IllegalDependencyException, NotEntitledException, MissingDataException, 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
ToolsException
IllegalDependencyException
NotEntitledException
MissingDataException
ObjectNotFoundException
void movePlaceableInPageInstance(PlaceableInstanceId placeableId, int placeholder, int position, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, IllegalDependencyException, NotEntitledException, 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
ToolsException
IllegalDependencyException
NotEntitledException
ObjectNotFoundException
void movePlaceable(PlaceableInstanceId placeableId, int placeholder, int position, PageInstanceId fromPageInstanceId, PageInstanceId toPageInstanceId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, IllegalDependencyException, NotEntitledException, 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
ToolsException
IllegalDependencyException
NotEntitledException
ObjectNotFoundException
PageInstanceId rename(String newTitle, PageInstanceId id, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException, 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
ToolsException
NotEntitledException
ObjectNotFoundException
MissingDataException
void removePlaceableFromPageInstance(PlaceableInstanceId placeableId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, MissingDataException, 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
ToolsException
NotEntitledException
MissingDataException
ObjectNotFoundException
boolean isPlaceholderLocked(int placeholder, PageInstanceId pageId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws 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
ToolsException
void setPlaceholderLock(int placeholder, PageInstanceId pageId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws 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
ToolsException
com.bea.p13n.entitlements.common.PolicyCreateException
com.bea.p13n.entitlements.common.PolicyExistsException
void removePlaceholderLock(int placeholder, PageInstanceId pageId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws 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
ToolsException
com.bea.p13n.entitlements.common.PolicyRemoveException
com.bea.p13n.entitlements.common.PolicyNotFoundException
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |