|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPageInstanceManager
This is the primary interface for performing persistent store operations on PageInstance
objects. In general this interface provides coarse grain getters and fine grain setters.
It is important to note that all methods on this interface are fully internationalized and entitled. All titles and descriptions on the objects returned by these methods are internationalized to the preferred locale. Also, all methods are entitled, meaning if the caller does not have the required credentials the method may return a subset of the actual list or be unable to perform the specified function.
Most "Instances" can be thought of as objects tied to a desktop, An Admin has instances derived from the library Definition, and the "end user" has instances derived from the admin instance. Changes made via these APIs require a DesktopDefinitionId and the changes are scoped to that desktop. In other words changes made here do not affect the library or other Desktops. If the "visitorMode" on the customization Context is set the false (default) and the user executing the call is in the "Admin" or "PortalSystemAdministrator" role then these changes take affect at the admin level, and affect ALL users. If the visitorMode is false then the changes only affect the calling user.
CustomizationContext.setVisitorMode(boolean)
Method Summary | |
---|---|
PlaceableInstance |
addPlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) Add a placeable (book or portlet) to a page in a specified location. |
PageInstance |
getPageInstance(CustomizationContext customizationContext, PageInstanceId pageInstanceId) Getter for returning a single PageInstance . |
PageView |
getPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId) Getter for returning an immutable deep PageView. |
PageView |
getPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel) Getter for returning an immutable deep PageView. |
PageView |
getShallowPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId) Getter for returning an immutable shallow PageView. |
PageView |
getShallowPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel) Getter for returning an immutable shallow PageView. |
void |
movePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlacementId placementId, PageInstanceId toPageInstanceId, PlaceholderDefinitionId placeholderDefinitionId, int position) Move a placeable instance from one placeholder to another. |
void |
movePortlet(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel, String portletInstanceLabel, int placeholder, int position) Move a portlet on a page. |
void |
removePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlaceableInstance placeableInstance) Remove a placeable (portlet or book) from a page's placeholder. |
PageInstance |
updatePageInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstance pageInstance) Update the page instance with the new data. |
Method Detail |
---|
PageView getPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId) throws RemoteException
Getter for returning an immutable deep PageView. The PageView
object, unlike the PageDefinition
or the PageInstance
objects contains a full set of references to all child pages, pages and so on. The PageView
object, however is immutable.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.desktopDefinitionId
- the desktop definition this page is placed inpageInstanceId
- the unique pageInstanceId.RemoteException
PageView getPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel) throws RemoteException
Getter for returning an immutable deep PageView. This method is very similiar to the other getPageView() method, however it does not require knowledge of the pageInstanceId. The correct page instance is returned via the desktop definition id, the page definition label and the visitor mode on the customization context. If visitor mode is set to false the default desktop view will be returned
customizationContext
- customization information: information used here is VistorMode, username and locale.desktopDefinitionId
- the desktop definition this page is placed inpageDefinitionLabel
- definition label of the page.RemoteException
PageView getShallowPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId) throws RemoteException
Getter for returning an immutable shallow PageView. The returned view object will be shallow in the sense that it will have no child book or portlet view arrays. However, you can lazily retrieve those by calling the paginated PageView.getPagedPlaceables method.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.desktopDefinitionId
- the desktop definition this page is placed inpageInstanceId
- the unique pageInstanceId.RemoteException
PageView getShallowPageView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel) throws RemoteException
Getter for returning an immutable shallow PageView. This method is very similiar to the other getShallowPageView() method, however it does not require knowledge of the pageInstanceId. The correct page instance is returned via the desktop definition id, the page definition label and the visitor mode on the customization context. If visitor mode is set to false the default desktop view will be returned
customizationContext
- customization information: information used here is VistorMode, username and locale.desktopDefinitionId
- the desktop definition this page is placed inpageDefinitionLabel
- definition label of the page.RemoteException
PageInstance getPageInstance(CustomizationContext customizationContext, PageInstanceId pageInstanceId) throws RemoteException
Getter for returning a single PageInstance
.
customizationContext
- customization information such as preferred locales and desktopInstanceId returned.RemoteException
PageDefinition
PageInstance updatePageInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstance pageInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the page instance with the new data.
desktopDefinitionId
- the desktop this instance is associated withpageInstance
- the page definition containing the new dataObjectNotFoundException
- if the LocalizationIntersectionId in the LocalizationResource is bogus.RemoteException
NotEntitledException
PlaceableInstance addPlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PageInstanceId pageInstanceId, PlaceableDefinitionId placeableDefinitionId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException, IllegalDependencyException
customizationContext
- customization information such as preferred locales.desktopDefinitionId
- context of the desktop to which this appliespageInstanceId
- the page instance id of the page to add the placeable.placeableDefinitionId
- the abstract definition id of the placeableplaceholderDefinitionId
- the placehoder to place this placeable in.position
- the position in the placeholder to insert the placeholder.ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogusIllegalDependencyException
- adding the Placeable to the PageInstance would cause a recursive dependancyMissingDataException
- the placeableDefinition is missing some vital data.NotEntitledException
- the caller is not entitled to perform this actionRemoteException
CustomizationContext.setVisitorMode(boolean)
void movePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlacementId placementId, PageInstanceId toPageInstanceId, PlaceholderDefinitionId placeholderDefinitionId, int position) throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException
customizationContext
- customization information such as preferred locales.desktopDefinitionId
- context of the desktop to which this appliesplacementId
- the placement id of the placeables current placement within the pagetoPageInstanceId
- the id of the page to move the placeable to.placeholderDefinitionId
- the new placehoder to place this placeable in.position
- the position in the placeholder to insert the placeholder.ObjectNotFoundException
- if the PageDefinitionId or the PlaceholderDefinition Id are bogusNotEntitledException
- the caller is not entitled to perform this actionRemoteException
IllegalDependencyException
void removePlaceable(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PlaceableInstance placeableInstance) throws RemoteException, ObjectNotFoundException, MissingDataException, NotEntitledException
Remove a placeable (portlet or book) from a page's placeholder. This operation will end up deleting the placeable's instance but not the placeable's definitions.
Note: be careful calling this method with CustomizationContext.setVisitorMode(false/true)
. If the placeable was not obtained from the correct view. In other words, if a visitor is looking at their desktop and want to remove a placeable and has permission to setVisitorMode(false) the placeable may not be on the admin’s view and hence you will get an ObjectNotFoundException
customizationContext
- customization information such as preferred locales.desktopDefinitionId
- context of the desktop to which this appliesplaceableInstance
- the instance to be removedObjectNotFoundException
- If the padeDefinitionId or the placeableInstanceId are bogus definition is in use by other instance.NotEntitledException
- the caller is not entitled to perform this actionRemoteException
MissingDataException
void movePortlet(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String pageDefinitionLabel, String portletInstanceLabel, int placeholder, int position) throws RemoteException, ObjectNotFoundException, NotEntitledException, IllegalDependencyException
customizationContext
- customization information such as preferred locales.desktopDefinitionId
- context of the desktop to which this appliespageDefinitionLabel
- the definition label of the parent pageportletInstanceLabel
- the instance label of the portlet to moveplaceholder
- the nth layout location in the layout (0..n)position
- the position within the placeholderObjectNotFoundException
- one ore more of the parameters passed in could not be tied to an object.NotEntitledException
- the caller is not entitled to perform this actionRemoteException
IllegalDependencyException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.