|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface PortletDefinitionControl
A custom control interface used to interact with portlet definition.
Method Summary | |
---|---|
PortletDefinition |
clonePortletDefinition(PortletDefinitionId id,
ResourceContext context)
Clones and creates new Portlet Definition based on the provided portlet definition id. |
void |
deletePortletDefinition(PortletDefinitionId id,
boolean cascade,
ResourceContext context)
Removes portlet definitions based on the provided list of portlet definition Ids with optional cascading. |
PortletDefinition |
getPortletDefinition(PortletDefinitionId id,
ResourceContext context)
Returns a single PortletDefinition based on the provided
portlet definition ID. |
SortableFilterablePagedResult<PortletDefinition> |
getPortletDefinitions(int pageSize,
WebAppSearchCriteria criteria,
ResourceContext context)
Returns every portlet definition for the provided webapp. |
PortletView |
getPortletView(PortletDefinitionId id,
ResourceContext context)
Returns a PortletView based on the provided portlet
definition ID. |
void |
setForkRender(boolean multithread,
PortletDefinitionId id,
ResourceContext context)
Convienience method for setting the Thread behavior for the provided portlet. |
void |
updateCache(boolean isCacheable,
int cacheTime,
PortletDefinitionId id,
ResourceContext context)
Updates the portlet definition cache setting. |
void |
updateTheme(ThemeDefinitionId themeId,
PortletDefinitionId portletId,
ResourceContext context)
Updates a portlet definition theme based on the provided portlet definition Id. |
void |
updateTitleAndDescription(String title,
String description,
PortletDefinitionId id,
ResourceContext context)
Updates the portlet definition title and description. |
Method Detail |
---|
void deletePortletDefinition(PortletDefinitionId id, boolean cascade, ResourceContext context) throws ObjectInUseException, ToolsException, NotEntitledException, ObjectNotFoundException
ResourceContext
via the setWebApp() method, otherwise
a NoWebAppFoundException
is thrown.
id
- the portlet definition to deletecascade
- context
- the resource context
ObjectInUseException
ToolsException
NotEntitledException
ObjectNotFoundException
PortletDefinition clonePortletDefinition(PortletDefinitionId id, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
id
- the portlet definition to clonecontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
void updateTheme(ThemeDefinitionId themeId, PortletDefinitionId portletId, ResourceContext context) throws NotEntitledException, ToolsException, ObjectNotFoundException
themeId
- the new theme, or null for no themeportletId
- the portlet to change the theme oncontext
- the resource context
NotEntitledException
ToolsException
ObjectNotFoundException
void updateCache(boolean isCacheable, int cacheTime, PortletDefinitionId id, ResourceContext context) throws NotEntitledException, ToolsException, ObjectNotFoundException
isCacheable
- cacheTime
- id
- the portlet definition id to specify cache settings oncontext
- the resource context
NotEntitledException
ToolsException
ObjectNotFoundException
void updateTitleAndDescription(String title, String description, PortletDefinitionId id, ResourceContext context) throws NotEntitledException, ToolsException, ObjectNotFoundException
title
- description
- id
- the portlet definition id to specify the title and descriptioncontext
- the resource context
NotEntitledException
ToolsException
ObjectNotFoundException
void setForkRender(boolean multithread, PortletDefinitionId id, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
updatePortletDefinition
.
multithread
- id
- the ID of the portlet to set forked rendering behavior oncontext
- the resource context
ToolsException
NotEntitledException
ObjectNotFoundException
PortletDefinition getPortletDefinition(PortletDefinitionId id, ResourceContext context) throws ToolsException
PortletDefinition
based on the provided
portlet definition ID.
id
- the ID of the portlet to get the definition ofcontext
- the resource context
ToolsException
SortableFilterablePagedResult<PortletDefinition> getPortletDefinitions(int pageSize, WebAppSearchCriteria criteria, ResourceContext context) throws ToolsException
pageSize
- the number of portlet definitions returned in each pagecriteria
- the criteria for the search, including web app namecontext
- the resource context
ToolsException
PortletView getPortletView(PortletDefinitionId id, ResourceContext context) throws ToolsException
PortletView
based on the provided portlet
definition ID.
id
- the id of the portlet definition to get a view of.context
- the resource context
ToolsException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |