|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
CustomizationContext.setVisitorMode(boolean)
Method Summary | |
PortletInstanceId |
createSuccessor(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PortletInstanceId portletInstanceId)
Creates a successor instance and returns its instance ID. |
PortletInstanceId |
createSuccessor(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PortletInstanceId portletInstanceId,
boolean forceCreateSuccessor)
Creates a successor instance and returns its instance ID. |
void |
deletePortletInstance(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Deletes a portlet instance. |
PortletInstance |
getPortletInstance(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Getter for returning a single PortletInstance . |
PortletView |
getPortletView(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Getter for returning an immutable deep copy of a PortletView. |
PortletInstanceId |
getPredecessor(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Returns the instance ID that the given instance is based on. |
PortletInstanceId[] |
getSuccessors(CustomizationContext customizationContext,
PortletInstanceId portletInstanceId)
Returns a list of successor instances. |
PortletInstance |
updatePortletInstance(CustomizationContext customizationContext,
DesktopDefinitionId desktopDefinitionId,
PortletInstance portletInstance)
Update the portlet instance with the new data. |
PortletInstance |
updatePortletInstance(CustomizationContext customizationContext,
PortletInstance portletInstance)
Update the portlet instance outside the context of a desktop (in a Library). |
Method Detail |
public PortletInstanceId createSuccessor(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PortletInstanceId portletInstanceId) throws RemoteException, 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.
desktopDefinitionId
- the desktop context to which this chage applies.portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
NotEntitledException
public PortletInstanceId createSuccessor(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PortletInstanceId portletInstanceId, boolean forceCreateSuccessor) throws RemoteException, 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.
desktopDefinitionId
- the desktop context to which this chage applies.portletInstanceId
- the portlet instance IDforceCreateSuccessor
- if true
- forces the underlying
store to create a new successor
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
NotEntitledException
public void deletePortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, NotEntitledException
Deletes a portlet instance. Note that instances associated with other aggregating entities such as pages should not be deleted directly using this method.
customizationContext
- portletInstanceId
-
RemoteException
NotEntitledException
- if the caller is entitled to delete the instancepublic PortletInstance getPortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException
Getter for returning a single PortletInstance
.
customizationContext
- the preferred language, country and variant to which the titles and descriptions are
returned.
RemoteException
PortletDefinition
public PortletView getPortletView(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException
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.
customizationContext
- customization information such as Locales and DesktopInstaceIdportletInstanceId
- the unique portletInstanceId.
RemoteException
public PortletInstanceId getPredecessor(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException
Returns the instance ID that the given instance is based
on. Returns null
if there is no predecessor
portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
public PortletInstanceId[] getSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException
Returns a list of successor instances. Returns an empty list if there are no successors.
portletInstanceId
- the portlet instance ID
ObjectNotFoundException
- if the PortletInstanceId does
not exist.
RemoteException
public PortletInstance updatePortletInstance(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, PortletInstance portletInstance) throws RemoteException, 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)
.
desktopDefinitionId
- the desktop context this instance is associated with.portletInstance
- the portlet instance containing the new data
ObjectNotFoundException
- if the PortletInstanceId in the PortletInstance, or desktopInstanceId
is bogus.
RemoteException
NotEntitledException
updatePortletInstance(CustomizationContext,PortletInstance)
public PortletInstance updatePortletInstance(CustomizationContext customizationContext, PortletInstance portletInstance) throws RemoteException, 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().
portletInstance
- the portlet instance containing the new data
ObjectNotFoundException
- if the PortletInstanceId in the PortletInstance
is bogus.
RemoteException
NotEntitledException
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |