|
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 IPortletInstanceManager
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. |
PortletInstanceId[] |
getAllSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) Returns a list of all successor instances including successors of successors. |
PortletInstanceId[] |
getNonPlacedPortletInstanceIds() Finds portlet instance IDs that are not associated with any placements. |
PortletInstance |
getPortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) Getter for returning a single PortletInstance . |
PortletView |
getPortletView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String instanceLabel) Getter for returning an immutable deep PortletView. |
PortletView |
getPortletView(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) Getter for returning an immutable deep 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. |
void |
revertPortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) This method removes a portlet instance and replaces all occurrences of it by a reference to the parent instance. |
void |
revertPortletSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) This method removes any customizations of a given portlet instance. |
void |
revertUserPortletInstance(CustomizationContext customizationContext, DesktopDefinitionId desktop, String portletInstanceLabel, String username) This method removes any customizations of a given portlet instance, for a given user. |
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 (i.e. |
Method Detail |
---|
PortletView getPortletView(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException
Getter for returning an immutable deep 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 DesktopInstanceIdportletInstanceId
- the unique portletInstanceId.RemoteException
PortletView getPortletView(CustomizationContext customizationContext, DesktopDefinitionId desktopDefinitionId, String instanceLabel) throws ObjectNotFoundException, RemoteException
Getter for returning an immutable deep 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 Locale, visitormode, and username.desktopDefinitionId
- webapp, portal path and desktop path this portlet is oninstanceLabel
- of the portlet.ObjectNotFoundException
- if the supplied desktop does not exist.RemoteException
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
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 (i.e. in a library) you should use updatePortletInstance(PortletInstance)
.desktopDefinitionId
- the desktop context this instance is associated with.portletInstance
- the portlet instance containing the new dataObjectNotFoundException
- if the PortletInstanceId in the PortletInstance, or desktopInstanceId is bogus.RemoteException
NotEntitledException
updatePortletInstance(CustomizationContext,PortletInstance)
PortletInstance updatePortletInstance(CustomizationContext customizationContext, PortletInstance portletInstance) throws RemoteException, ObjectNotFoundException, NotEntitledException
Update the portlet instance outside the context of a desktop (i.e. in a library). For admins editing the primary instance (not placed on any page) use PortletDefinitionManager.updatePortletDefinition().
portletInstance
- the portlet instance containing the new dataObjectNotFoundException
- if the PortletInstanceId in the PortletInstance is bogus.RemoteException
NotEntitledException
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 IDObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
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 IDObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
PortletInstanceId[] getAllSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException
Returns a list of all successor instances including successors of successors. Returns a zero-length array if this is a user instance. Otherwise this method returns all successor id's, including this id.
portletInstanceId
- the portlet instance IDObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
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 change applies.portletInstanceId
- the portlet instance IDObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
NotEntitledException
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 change applies.portletInstanceId
- the portlet instance IDforceCreateSuccessor
- if true
- forces the underlying store to create a new successorObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
NotEntitledException
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
- the CustomizationContext
portletInstanceId
- the instance id of the portlet to deleteRemoteException
NotEntitledException
- if the caller is entitled to delete the instancePortletInstanceId[] getNonPlacedPortletInstanceIds() throws RemoteException
Finds portlet instance IDs that are not associated with any placements.
RemoteException
void revertUserPortletInstance(CustomizationContext customizationContext, DesktopDefinitionId desktop, String portletInstanceLabel, String username) throws RemoteException, ObjectNotFoundException, NotEntitledException
This method removes any customizations of a given portlet instance, for a given user. Any page placements referring to a successor are updated to refer to the parent instance. All successor instances are deleted. This method traverses the entire tree of successors, so successors of successors are deleted, and so on.
customizationContext
- the CustomizationContext
desktop
- the parent DesktopDefinition. Only portlet instances belonging to this desktop will be affected.portletInstanceLabel
- the portlet instance for which the successors should be deleted.username
- Only portlets that have been customized by the given user will be affectedObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
NotEntitledException
void revertPortletSuccessors(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException, NotEntitledException
This method removes any customizations of a given portlet instance. Any page placements referring to a successor are updated to refer to the parent instance. All successor instances are deleted. This method traverses the entire tree of successors, so successors of successors are deleted, and so on.
customizationContext
- the CustomizationContext
portletInstanceId
- the id of the portlet instance whose successors should be revertedObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
NotEntitledException
void revertPortletInstance(CustomizationContext customizationContext, PortletInstanceId portletInstanceId) throws RemoteException, ObjectNotFoundException, NotEntitledException
This method removes a portlet instance and replaces all occurrences of it by a reference to the parent instance. You can use this method to undo a customization. Any page placements referring to this portlet are updated to refer to the parent instance. All successor instances are deleted. This method traverses the entire tree of successors, so successors of successors are deleted, and so on.
customizationContext
- the CustomizationContext
portletInstanceId
- the id of the portlet instance to be revertedObjectNotFoundException
- if the PortletInstanceId does not exist.RemoteException
NotEntitledException
|
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.