This is the primary interface for performing persistent store operations
on PageDefinitions
. 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 prefered 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.Related Topics
CustomizationContext.setVisitorMode(boolean)
PortalCustomizationManager
Method Summary |
public |
|
public |
|
public |
|
public void |
|
public void |
|
public |
|
Method Detail |
publicAdd a placeable (book or portlet) to a page in a specified location. This will create a new placeable instance.PlaceableInstance
addPlaceable(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PageInstanceId
pageInstanceId,PlaceableDefinitionId
placeableDefinitionId,PlaceholderDefinitionId
placeholderDefinitionId, int position)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
,IllegalDependencyException
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
IllegalDependencyException
Related Topics
CustomizationContext.setVisitorMode(boolean)
publicPageInstance
getPageInstance(CustomizationContext
customizationContext,PageInstanceId
pageInstanceId)
throwsRemoteException
Getter for returning a single PageInstance
.
RemoteException
Related Topics
publicPageView
getPageView(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PageInstanceId
pageInstanceId)
throwsRemoteException
Getter for returning an immutable deep copy of a 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.
RemoteException
public void movePlaceable(Move a placeable instance from one placeholder to another. This method is useful for preserving the instance of paceable.CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PlacementId
placementId,PageInstanceId
toPageInstanceId,PlaceholderDefinitionId
placeholderDefinitionId, int position)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
,IllegalDependencyException
RemoteException
ObjectNotFoundException
NotEntitledException
IllegalDependencyException
public void removePlaceable(Remove a placeable from a page's placeholder. This operation will end up deleting the placeable's instance but not the placeables definitions.CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PlaceableInstance
placeableInstance)
throwsRemoteException
,ObjectNotFoundException
,MissingDataException
,NotEntitledException
RemoteException
ObjectNotFoundException
MissingDataException
NotEntitledException
publicPageInstance
updatePageInstance(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PageInstance
pageInstance)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the page instance with the new data.
RemoteException
ObjectNotFoundException
NotEntitledException