com.bea.portal.tools.portal.controls
Interface PortletDefinitionControl

public interface PortletDefinitionControl

A custom control interface used to interact with portlet definition.

Method Summary

com.bea.netuix.application.definition.PortletDefinition	clonePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Clones and creates new Portlet Definition based on the provided portlet definition id.
void	deletePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id, boolean cascade, com.bea.portal.tools.common.ResourceContext context) Removes portlet definitions based on the provided list of portlet definition Ids with optional cascading.
com.bea.netuix.application.definition.PortletDefinition	getPortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Returns a single PortletDefinition based on the provided portlet definition ID.
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition>	getPortletDefinitions(int pageSize, com.bea.netuix.application.search.WebAppSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) Returns every portlet definition for the provided webapp.
com.bea.netuix.application.view.PortletView	getPortletView(com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Returns a PortletView based on the provided portlet definition ID.
void	setForkRender(boolean multithread, com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Convienience method for setting the Thread behavior for the provided portlet.
void	updateCache(boolean isCacheable, int cacheTime, com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Updates the portlet definition cache setting.
void	updateTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId, com.bea.netuix.application.identifier.PortletDefinitionId portletId, com.bea.portal.tools.common.ResourceContext context) Updates a portlet definition theme based on the provided portlet definition Id.
void	updateTitleAndDescription(String title, String description, com.bea.netuix.application.identifier.PortletDefinitionId id, com.bea.portal.tools.common.ResourceContext context) Updates the portlet definition title and description.

Method Detail

deletePortletDefinition

void deletePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id,
                             boolean cascade,
                             com.bea.portal.tools.common.ResourceContext context)
                             throws com.bea.netuix.application.exception.ObjectInUseException,
                                    com.bea.portal.tools.common.exceptions.ToolsException,
                                    com.bea.netuix.application.exception.NotEntitledException,
                                    com.bea.netuix.application.exception.ObjectNotFoundException

Removes portlet definitions based on the provided list of portlet definition Ids with optional cascading. This method attempts to clean up all related security policies on the deleted Portlet. To achieve this, the current web app MUST be set in the ResourceContext via the setWebApp() method, otherwise a NoWebAppFoundException is thrown.

Parameters

id - the portlet definition to delete

cascade -

context - the resource context

Throws

com.bea.netuix.application.exception.ObjectInUseException

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.NotEntitledException

com.bea.netuix.application.exception.ObjectNotFoundException

clonePortletDefinition

com.bea.netuix.application.definition.PortletDefinition clonePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id,
                                                                               com.bea.portal.tools.common.ResourceContext context)
                                                                               throws com.bea.portal.tools.common.exceptions.ToolsException,
                                                                                      com.bea.netuix.application.exception.NotEntitledException,
                                                                                      com.bea.netuix.application.exception.ObjectNotFoundException

Clones and creates new Portlet Definition based on the provided portlet definition id. Note: Use the PortletDefinitionAction.copyPortletDefinition() action to clone a portlet and set its title and description.

Parameters

id - the portlet definition to clone

context - the resource context

Returns

Throws

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.NotEntitledException

com.bea.netuix.application.exception.ObjectNotFoundException

updateTheme

void updateTheme(com.bea.netuix.application.identifier.ThemeDefinitionId themeId,
                 com.bea.netuix.application.identifier.PortletDefinitionId portletId,
                 com.bea.portal.tools.common.ResourceContext context)
                 throws com.bea.netuix.application.exception.NotEntitledException,
                        com.bea.portal.tools.common.exceptions.ToolsException,
                        com.bea.netuix.application.exception.ObjectNotFoundException

Updates a portlet definition theme based on the provided portlet definition Id.

Parameters

themeId - the new theme, or null for no theme

portletId - the portlet to change the theme on

context - the resource context

Throws

com.bea.netuix.application.exception.NotEntitledException

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.ObjectNotFoundException

updateCache

void updateCache(boolean isCacheable,
                 int cacheTime,
                 com.bea.netuix.application.identifier.PortletDefinitionId id,
                 com.bea.portal.tools.common.ResourceContext context)
                 throws com.bea.netuix.application.exception.NotEntitledException,
                        com.bea.portal.tools.common.exceptions.ToolsException,
                        com.bea.netuix.application.exception.ObjectNotFoundException

Updates the portlet definition cache setting.

Parameters

isCacheable -

cacheTime -

id - the portlet definition id to specify cache settings on

context - the resource context

Throws

com.bea.netuix.application.exception.NotEntitledException

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.ObjectNotFoundException

updateTitleAndDescription

void updateTitleAndDescription(String title,
                               String description,
                               com.bea.netuix.application.identifier.PortletDefinitionId id,
                               com.bea.portal.tools.common.ResourceContext context)
                               throws com.bea.netuix.application.exception.NotEntitledException,
                                      com.bea.portal.tools.common.exceptions.ToolsException,
                                      com.bea.netuix.application.exception.ObjectNotFoundException

Updates the portlet definition title and description.

Parameters

title -

description -

id - the portlet definition id to specify the title and description

context - the resource context

Throws

com.bea.netuix.application.exception.NotEntitledException

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.ObjectNotFoundException

setForkRender

void setForkRender(boolean multithread,
                   com.bea.netuix.application.identifier.PortletDefinitionId id,
                   com.bea.portal.tools.common.ResourceContext context)
                   throws com.bea.portal.tools.common.exceptions.ToolsException,
                          com.bea.netuix.application.exception.NotEntitledException,
                          com.bea.netuix.application.exception.ObjectNotFoundException

Convienience method for setting the Thread behavior for the provided portlet. This can also be done by calling updatePortletDefinition.

Parameters

multithread -

id - the ID of the portlet to set forked rendering behavior on

context - the resource context

Throws

com.bea.portal.tools.common.exceptions.ToolsException

com.bea.netuix.application.exception.NotEntitledException

com.bea.netuix.application.exception.ObjectNotFoundException

getPortletDefinition

com.bea.netuix.application.definition.PortletDefinition getPortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId id,
                                                                             com.bea.portal.tools.common.ResourceContext context)
                                                                             throws com.bea.portal.tools.common.exceptions.ToolsException

Returns a single PortletDefinition based on the provided portlet definition ID.

Parameters

id - the ID of the portlet to get the definition of

context - the resource context

Returns

Throws

com.bea.portal.tools.common.exceptions.ToolsException

getPortletDefinitions

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition> getPortletDefinitions(int pageSize,
                                                                                                                                     com.bea.netuix.application.search.WebAppSearchCriteria criteria,
                                                                                                                                     com.bea.portal.tools.common.ResourceContext context)
                                                                                                                                     throws com.bea.portal.tools.common.exceptions.ToolsException

Returns every portlet definition for the provided webapp.

Parameters

pageSize - the number of portlet definitions returned in each page

criteria - the criteria for the search, including web app name

context - the resource context

Returns

Throws

com.bea.portal.tools.common.exceptions.ToolsException

getPortletView

com.bea.netuix.application.view.PortletView getPortletView(com.bea.netuix.application.identifier.PortletDefinitionId id,
                                                           com.bea.portal.tools.common.ResourceContext context)
                                                           throws com.bea.portal.tools.common.exceptions.ToolsException

Returns a PortletView based on the provided portlet definition ID.

Parameters

id - the id of the portlet definition to get a view of.

context - the resource context

Returns

Throws

com.bea.portal.tools.common.exceptions.ToolsException