com.webmethods.portal.service.portlet

Interface IPortletBean

All Superinterfaces:

IContentProvider, IPropertyBag, IView, Serializable

public interface IPortletBean
extends IPropertyBag, IContentProvider, IView

This is portlet bean interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLIENT_RENDERING_PASS Deprecated.
static int	SERVER_RENDERING_PASS Deprecated.

Fields inherited from interface com.webmethods.portal.service.view.IView

PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

Modifier and Type	Method and Description
IPortletURL	createActionUrl() Creates new action URL.
IPortletURL	createRenderUrl() Creates new render URL.
String	encodeURL(String url) Encodes web resource url.
String	getContentSchema() Deprecated.
IPortletControllerBean	getControllerBean() Returns the portlet controller bean or null if it's the portlet controller is not configured in the portlet descriptor.
String	getNamespace() Returns portlet namespace that must be used to prefix all page elements that require uniqueness within the page.
IContext	getPortletContext() Returns the context for the portlet.
IPortletInfo	getPortletInfo() Returns the portlet descriptor object
IThingID	getPortletThingID() Returns the thing ID of the portlet instance
IPortletTitleBar	getPortletTitleBar() Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet
String	getPortletTypeName() Returns the portlet type name.
int	getRenderingPass() Deprecated.
String	getResourceLocation(String resourceUri, boolean isWebResource) Returns full URI for the portlet's relative resource.
boolean	getTwoPassRenderingSupported() Deprecated.
boolean	hasPortletTitleBar() Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet
boolean	isDirectContentOutputEnabled()
void	setDirectContentOutputEnabled(boolean enabled) Disables or enables 'optimized' direct content output of the IContentProvider.getContent() method.
void	setPortletContext(IContext context) Sets the context for the portlet.
void	setPortletTitleBar(IPortletTitleBar portletTitleBar) Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet
void	setPortletTypeName(String portletTypeName) Sets the portlet type name.
void	setRenderingPass(int renderingPass) Deprecated.
void	setTwoPassRenderingSupported(boolean supported) Deprecated.

Methods inherited from interface com.webmethods.rtl.util.obj.IPropertyBag

assignProperties, createCopy, getProperties, getProperty, load, load, load, save, save, setProperties, setProperty

Methods inherited from interface com.webmethods.portal.service.portlet.IContentProvider

getContent, getContentType, getContentTypes, isContentTypeSupported, setContentType

Methods inherited from interface com.webmethods.portal.service.view.IView

getProperties, getProperty, getPropertyNames, getURI

Field Detail

SERVER_RENDERING_PASS

@Deprecated
static final int SERVER_RENDERING_PASS

Deprecated.

See Also:

Constant Field Values

CLIENT_RENDERING_PASS

@Deprecated
static final int CLIENT_RENDERING_PASS

Deprecated.

See Also:

Constant Field Values

Method Detail

getPortletTypeName

String getPortletTypeName()

Returns the portlet type name. Example: wm_myportlet

Returns:

portlet type name

setPortletTypeName

void setPortletTypeName(String portletTypeName)

Sets the portlet type name. Called by the portal during the portlet initialization.

Parameters:

portletTypeName - the name of the portlet type.

setPortletContext

void setPortletContext(IContext context)
                throws PortalException

Sets the context for the portlet. Called by the portal during the portlet initialization.

Parameters:

context - portlet context.

Throws:

PortalException

getPortletContext

IContext getPortletContext()

Returns the context for the portlet.

Returns:

context portlet context

See Also:

setPortletContext(com.webmethods.portal.bizPolicy.IContext)

setPortletTitleBar

@Deprecated
void setPortletTitleBar(IPortletTitleBar portletTitleBar)

Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet

Parameters:

portletTitleBar - new title bar

getPortletTitleBar

@Deprecated
IPortletTitleBar getPortletTitleBar()
                                         throws PortalException

Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet

Returns:

IPortletTitleBar implementation for this portlet

Throws:

PortalException

hasPortletTitleBar

@Deprecated
boolean hasPortletTitleBar()
                                throws PortalException

Deprecated. The method is deprecated in favor of per shell title bar setting instead of per portlet

Throws:

PortalException

setTwoPassRenderingSupported

@Deprecated
void setTwoPassRenderingSupported(boolean supported)

Deprecated.

getTwoPassRenderingSupported

@Deprecated
boolean getTwoPassRenderingSupported()

Deprecated.

setRenderingPass

@Deprecated
void setRenderingPass(int renderingPass)

Deprecated.

getRenderingPass

@Deprecated
int getRenderingPass()

Deprecated.

getContentSchema

@Deprecated
String getContentSchema()
                             throws PortalException

Deprecated.

Throws:

PortalException

getPortletInfo

IPortletInfo getPortletInfo()
                     throws PortalException

Returns the portlet descriptor object

Returns:

IPortletInfo object

Throws:

PortalException

getPortletThingID

IThingID getPortletThingID()
                    throws PortalException

Returns the thing ID of the portlet instance

Returns:

the portlet thing id

Throws:

PortalException

setDirectContentOutputEnabled

void setDirectContentOutputEnabled(boolean enabled)
                            throws PortalException

Disables or enables 'optimized' direct content output of the IContentProvider.getContent() method. If direct output is disabled then you can get the content by calling IContentProvider.getContent() method. Otherwise {@link #getContent) method may return null and the content is streamed out directly to the client agent. This is to support the portal on application servers.

Parameters:

enabled - false if you want to get the whole portlet content by calling getContent method.

Throws:

PortalException

See Also:

isDirectContentOutputEnabled()

isDirectContentOutputEnabled

boolean isDirectContentOutputEnabled()

Returns:

whether the direct content output is enabled

See Also:

setDirectContentOutputEnabled(boolean)

getControllerBean

IPortletControllerBean getControllerBean()
                                  throws PortalException

Returns the portlet controller bean or null if it's the portlet controller is not configured in the portlet descriptor.

Returns:

current portlet controller bean

Throws:

PortalException

getResourceLocation

String getResourceLocation(String resourceUri,
                           boolean isWebResource)

Returns full URI for the portlet's relative resource.

Parameters:

resourceUri - relative to the widget base folder url to the required resource

isWebResource - true if the resource is a static web source, like .html, .jpeg

Returns:

location of the resource

getNamespace

String getNamespace()

Returns portlet namespace that must be used to prefix all page elements that require uniqueness within the page. For example HTML id's, javascript names, etc.

Returns:

namespace for this portlet instance

createActionUrl

IPortletURL createActionUrl()
                     throws PortalException

Creates new action URL. Action URL is intended to invoke a PCA method againt this portlet. The method is set using IPortletURL.setPortletMethod(String)

Returns:

instance of IPortletURL that can be further customized

Throws:

PortalException

createRenderUrl

IPortletURL createRenderUrl()
                     throws PortalException

Creates new render URL. Render URL is not intended to to change any state on the data the portlet displays or manages. Render URL cannot invoke a PCA method. Handling of the render url is optimized and does not require http redirect after it is handled.

Returns:

instance of IPortletURL that can be further customized

Throws:

PortalException

encodeURL

String encodeURL(String url)

Encodes web resource url. Ensures that url to a web resource is properly encoded for the current client. Used by WSRP producer for url re-writing

Parameters:

url - url to a portal web resource like images, css, java scripts, etc

Returns:

the same url if encoding is not necessary or properly encoded url