This is the primary interface for performing persistent store operations
on DesktopInstance
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.Related Topics
CustomizationContext.setVisitorMode(boolean)
PortalCustomizationManager
Method Summary |
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
Method Detail |
public void deleteDesktopCustomizations(Delete/Remove all the customization for a particular user. This method should be called when a user is deleted from the system. Or you wish to remove all a user customizations.String
username)
throwsRemoteException
,NotEntitledException
RemoteException
NotEntitledException
publicDesktopView
getCustomizedDesktopView(CustomizationContext
customizationContext,String
webAppName,PortalPath
portalPath,DesktopPath
desktopPath)
throwsRemoteException
Getter for returning an immutable deep copy of a DesktopView. If the user has customized
his desktop then this will return the user's specific instance otherwise null is returned.
The DesktopView
object, unlike the DesktopDefinition
or
the DesktopInstance
objects contains a deep copy of all references to all child pages,
books and so on. The DesktopView
object however is immutable.
RemoteException
Related Topics
IDesktopDefinitionManager.getDesktopView(CustomizationContext, DesktopDefinitionId)
publicDesktopInstance
getDesktopInstance(CustomizationContext
customizationContext,DesktopInstanceId
desktopInstanceId)
throwsRemoteException
Getter for returning a DesktopInstance
identified by the supplied instance id.
DesktopInstance
objects if it exist, otherwise null. RemoteException
publicDesktopView
getDesktopView(CustomizationContext
customizationContext,String
webAppName,PortalPath
portalPath,DesktopPath
desktopPath)
throwsRemoteException
Getter for returning an immutable deep copy of a DesktopView. If the user has customized
his deskotp then this will return the user's specific instance. The DesktopView
object, unlike the DesktopDefinition
or the DesktopInstance
objects
contains a deep copy of all references to all child pages, books and so on. The
DesktopView
object however is immutable.
RemoteException
Related Topics
IDesktopDefinitionManager.getDesktopView(CustomizationContext, DesktopDefinitionId)
publicDesktopView
getDesktopView(CustomizationContext
customizationContext,DesktopInstanceId
desktopInstanceId)
throwsRemoteException
Getter for returning an immutable deep copy of a DesktopView. The DesktopView
object, unlike the DesktopDefinition
or the DesktopInstance
objects
contains a deep copy of all references to all child pages, books and so on. The
DesktopView
object however is immutable.
RemoteException
Related Topics
IDesktopDefinitionManager.getDesktopView(CustomizationContext, DesktopDefinitionId)
publicDesktopInstance
updateDesktopInstance(CustomizationContext
customizationContext,DesktopInstance
desktopInstance)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the persistent store for the supplied DesktopInstance
. All attributes of the DesktopInstance
are updated in persistent store.
RemoteException
ObjectNotFoundException
NotEntitledException