|
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 |
@ControlInterface
public interface PortletInstanceControl
A custom control interface used to interact with portlet instances.
Method Summary | |
---|---|
PortletInstanceId |
createSuccessor(DesktopDefinitionId desktopDefinitionId, PortletInstanceId id, ResourceContext context) Creates a successor instance and returns its instance ID. |
PortletInstanceId[] |
getAllSuccessors(PortletInstanceId id, ResourceContext context) Returns a list of all successor instances including successors of successors. |
PortletInstance |
getPortletInstance(PortletInstanceId id, ResourceContext context) Getter for returning a single PortletInstance . |
PortletView |
getPortletView(PortletInstanceId id, ResourceContext context) Getter for returning an immutable deep copy of a PortletView. |
PortletInstanceId |
getPredecessor(PortletInstanceId id, ResourceContext context) Returns the instance ID of the predecessor to the given instance ID. |
PortletInstanceId[] |
getSuccessors(PortletInstanceId id, ResourceContext context) Returns a list of successor instances. |
PortletInstance |
updatePortletInstance(PortletInstance portletInstance, DesktopDefinitionId desktopDefinitionId, ResourceContext context) Update the portlet instance within the context of a desktop. |
PortletInstance |
updatePortletInstance(PortletInstance portletInstance, ResourceContext context) Update the portlet instance outside the context of a desktop (in a Library). |
PortletInstance |
updateTheme(ThemeDefinitionId themeId, PortletInstanceId portletId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) Update the portlet instance Theme setting. |
Method Detail |
---|
PortletView getPortletView(PortletInstanceId id, ResourceContext context) throws ToolsException
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.
id
- the ID of the portlet to get a view for.context
- the resource contextToolsException
PortletInstance getPortletInstance(PortletInstanceId id, ResourceContext context) throws ToolsException
Getter for returning a single PortletInstance
.
id
- the ID of the portlet instance to retrievecontext
- the resource contextToolsException
PortletDefinition
PortletInstance updateTheme(ThemeDefinitionId themeId, PortletInstanceId portletId, String webApp, PortalPath portalPath, DesktopPath desktopPath, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
Update the portlet instance Theme setting. 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)
.themeId
- The ID of the new theme of this portlet instance, or null for noneportletId
- the ID of the portlet instancewebApp
- the web application nameportalPath
- the portal pathdesktopPath
- the desktop pathcontext
- the resource contextToolsException
NotEntitledException
ObjectNotFoundException
IPortletInstanceManager.updatePortletInstance(com.bea.netuix.application.manager.CustomizationContext,PortletInstance)
PortletInstance updatePortletInstance(PortletInstance portletInstance, DesktopDefinitionId desktopDefinitionId, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
Update the portlet instance within the context of a desktop. When not in visitor mode the admin instance is updated.
portletInstance
- the portlet instance containing the new datadesktopDefinitionId
- The desktop containing the instance to update.context
- the resource contextToolsException
NotEntitledException
ObjectNotFoundException
PortletInstance updatePortletInstance(PortletInstance portletInstance, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
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 datacontext
- the resource contextToolsException
NotEntitledException
ObjectNotFoundException
PortletInstanceId getPredecessor(PortletInstanceId id, ResourceContext context) throws ToolsException, ObjectNotFoundException
Returns the instance ID of the predecessor to the given instance ID. Returns null
if there is no predecessor
id
- the ID of the portlet instancecontext
- the resource contextToolsException
ObjectNotFoundException
PortletInstanceId[] getSuccessors(PortletInstanceId id, ResourceContext context) throws ToolsException, ObjectNotFoundException
Returns a list of successor instances. Returns an empty list if there are no successors.
id
- the ID of the portlet instancecontext
- the resource contextToolsException
ObjectNotFoundException
PortletInstanceId[] getAllSuccessors(PortletInstanceId id, ResourceContext context) throws ToolsException, ObjectNotFoundException
Returns a list of all successor instances including successors of successors. Returns an empty list if there are no successors.
id
- the ID of the portlet instancecontext
- the resource contextToolsException
ObjectNotFoundException
PortletInstanceId createSuccessor(DesktopDefinitionId desktopDefinitionId, PortletInstanceId id, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
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.id
- the ID of the portlet instancecontext
- the resource contextToolsException
NotEntitledException
ObjectNotFoundException
|
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.