org.apache.jetspeed.factory

Interface PortletInstance

All Superinterfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.ResourceServingPortlet

public interface PortletInstance
extends javax.portlet.Portlet, javax.portlet.EventPortlet, javax.portlet.ResourceServingPortlet

PortletInstance

Version:

$Id: PortletInstance.java 910295 2010-02-15 18:45:05Z woonsan $

Author:

Ate Douma

Method Summary

Methods

Modifier and Type	Method and Description
JetspeedPortletConfig	getConfig() Returns Jetspeed portlet config object.
javax.portlet.Portlet	getRealPortlet() Returns the real portlet object instance.
boolean	hasRenderHelperMethod(javax.portlet.PortletMode mode) Returns true when the real portlet object instance is type of javax.portlet.GenericPortlet and the instance contains a helper method for the portlet mode with public access.
boolean	isProxyInstance() True if the real portlet object instance is a proxy instance.

Methods inherited from interface javax.portlet.Portlet

destroy, init, processAction, render

Methods inherited from interface javax.portlet.EventPortlet

processEvent

Methods inherited from interface javax.portlet.ResourceServingPortlet

serveResource

Method Detail

getConfig

JetspeedPortletConfig getConfig()

Returns Jetspeed portlet config object.

Returns:

getRealPortlet

javax.portlet.Portlet getRealPortlet()

Returns the real portlet object instance. This portlet object instance can be a proxy instance. You can check if it is a proxy by using isProxyInstance().

Returns:

isProxyInstance

boolean isProxyInstance()

True if the real portlet object instance is a proxy instance.

Returns:

hasRenderHelperMethod

boolean hasRenderHelperMethod(javax.portlet.PortletMode mode)

Returns true when the real portlet object instance is type of javax.portlet.GenericPortlet and the instance contains a helper method for the portlet mode with public access.

The helper methods can be overriden from the javax.portlet.GenericPortlet such as the following methods or annotated with @RenderMode (javax.portlet.RenderMode).

• doView for handling view requests
• doEdit for handling edit requests
• doHelp for handling help requests

Parameters:

mode -

Returns:

See Also:

RenderMode, GenericPortlet.doView(RenderRequest, RenderResponse), GenericPortlet.doEdit(RenderRequest, RenderResponse), GenericPortlet.doHelp(RenderRequest, RenderResponse)