This is the primary interface for performing persistent store operations
on PortletInstances
. 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 |
|
public |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
Method Detail |
publicPortletInstanceId
createSuccessor(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PortletInstanceId
portletInstanceId)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Creates a successor instance and returns its instance ID. Returns the same instance ID if there is no need to create a successor instance.
RemoteException
ObjectNotFoundException
NotEntitledException
publicPortletInstanceId
createSuccessor(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PortletInstanceId
portletInstanceId, boolean forceCreateSuccessor)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Creates a successor instance and returns its instance ID. Returns the same instance ID if there is no need to create a successor instance.
true
- forces the underlying
store to create a new successor RemoteException
ObjectNotFoundException
NotEntitledException
public void deletePortletInstance(CustomizationContext
customizationContext,PortletInstanceId
portletInstanceId)
throwsRemoteException
,NotEntitledException
Deletes a portlet instance. Note that instances associated with other aggregating entities such as pages should not be deleted directly using this method.
RemoteException
NotEntitledException
publicPortletInstance
getPortletInstance(CustomizationContext
customizationContext,PortletInstanceId
portletInstanceId)
throwsRemoteException
Getter for returning a single PortletInstance
.
RemoteException
Related Topics
publicPortletView
getPortletView(CustomizationContext
customizationContext,PortletInstanceId
portletInstanceId)
throwsRemoteException
Getter for returning an immutable deep copy of a PortletView. The PortletView
object, unlike the PortletDefinition
or the PortletInstance
objects
contains a full set of references to all child portlets, portlets and so on. The
PortletView
object however is immutable.
RemoteException
publicPortletInstanceId
getPredecessor(CustomizationContext
customizationContext,PortletInstanceId
portletInstanceId)
throwsRemoteException
,ObjectNotFoundException
Returns the instance ID that the given instance is based
on. Returns null
if there is no predecessor
RemoteException
ObjectNotFoundException
publicPortletInstanceId
[] getSuccessors(CustomizationContext
customizationContext,PortletInstanceId
portletInstanceId)
throwsRemoteException
,ObjectNotFoundException
Returns a list of successor instances. Returns an empty list if there are no successors.
RemoteException
ObjectNotFoundException
publicPortletInstance
updatePortletInstance(CustomizationContext
customizationContext,DesktopDefinitionId
desktopDefinitionId,PortletInstance
portletInstance)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the portlet instance with the new data. If the portlet instance is the primary portlet instance then a new instance will be created specifically for this user or admin.
For an admin editing a portlet outside the context of a desktop (in a Library) you should use updatePortletInstance(PortletInstance)
.RemoteException
ObjectNotFoundException
NotEntitledException
Related Topics
IPortletInstanceManager.updatePortletInstance(CustomizationContext, PortletInstance)
publicPortletInstance
updatePortletInstance(CustomizationContext
customizationContext,PortletInstance
portletInstance)
throwsRemoteException
,ObjectNotFoundException
,NotEntitledException
Update the portlet instance outside the context of a desktop (in a Library). For Admins editing the primary instance (not placed on any page) use the PortletDefinitionManager.updatePortletDefinition().
RemoteException
ObjectNotFoundException
NotEntitledException