com.webmethods.portal.bizPolicy.biz.portlet

Interface IPortletPolicy

All Superinterfaces:

IBasicPolicy, IBizPolicy, IComponent, IInitializable, ISystemHandler, IViewablePolicy

public interface IPortletPolicy
extends IBasicPolicy

Business policy for portlets.

Method Summary

Modifier and Type	Method and Description
Object	executePortletMethod(IContext context, IURI portletUri, String method, Map<String,Object> properties) Executes portlet method on a IPortletBean loaded for portletUri with any additional properties loaded from properties parameter.
void	flushPortletCache(IContext context, IURI portletUri) Flushes all portlet presentation caches.
Reader	getPortletContent(IContext context, IURI portletUri) Creates IPortletBean for given uri, loads all its persisted properties and obtains its content using IContentProvider.getContent() method.
String	getPortletDescriptors(IContext context, IURI workspaceUri) Deprecated. no longer a supported operation

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.meta.IBasicPolicy

addNote, addToTopics, canUser, cloneRemote, copyToClipboard, cutToClipboard, delete, deleteReference, destroy, getContent, listContainers, listNotes, moveThing, moveThing, pasteFromClipboard, removeNote, setOwner, updateProperties

Methods inherited from interface com.webmethods.portal.bizPolicy.biz.view.IViewablePolicy

getIcon, getPagingCookie, getPagingCookie, pageBackward, pageForeward, setPagingCookie, view

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

getPortletContent

Reader getPortletContent(IContext context,
                         IURI portletUri)
                  throws BizException

Creates IPortletBean for given uri, loads all its persisted properties and obtains its content using IContentProvider.getContent() method. The IContext is used for setting IPortletBean.setPortletContext(com.webmethods.portal.bizPolicy.IContext).

Parameters:

context - Current IContext.

portletUri - Portlet instance IURI.

Returns:

Reader object with the portlet's content, can be NULL, if the content is directly streamed back to the http client

Throws:

BizException

See Also:

IContentProvider.getContent(), IPortletBean.setDirectContentOutputEnabled(boolean)

executePortletMethod

Object executePortletMethod(IContext context,
                            IURI portletUri,
                            String method,
                            Map<String,Object> properties)
                     throws BizException

Executes portlet method on a IPortletBean loaded for portletUri with any additional properties loaded from properties parameter. The method is executed via IPortletMechanics.executePortletMethod(com.webmethods.portal.service.portlet.IPortletBean, com.webmethods.portal.bizPolicy.IContext, java.lang.String). The method must be defined in the portlet descriptor as PCA method. See IPortletMethodInfo

Parameters:

context - Current IContext

portletUri - Portlet instance IURI.

method - Name of the method to execute

properties - Any additional properties that can augment or replace persisted properites

Returns:

an object returned from the portlet's method, not used by Portlet Controller Architecture

Throws:

BizException

getPortletDescriptors

@Deprecated
String getPortletDescriptors(IContext context,
                                         IURI workspaceUri)
                                  throws BizException

Deprecated. no longer a supported operation

Returns portlet descriptors xml for a given workspaceUri. The xml contains only portlets available for the user. Portlet descriptors are grouped into portlet categories.

Parameters:

context - Current IContext

workspaceUri - the workspace uri, can be NULL.

Returns:

serialized xml with portlet descriptors

Throws:

BizException

flushPortletCache

void flushPortletCache(IContext context,
                       IURI portletUri)
                throws BizException

Flushes all portlet presentation caches. Uses IPresentationCacheMechanics.invalidateDependentContent(com.webmethods.portal.service.meta2.thing.IThingID) to invalidate all content that depends on the portlet thing id.

Parameters:

context - Current IContext

portletUri - Portlet instance IURI.

Throws:

BizException

See Also:

IPresentationCacheMechanics