com.novell.afw.portlet.api
Interface EbiPortletContainer

All Known Subinterfaces:

EbiComponentContainer, EbiPortletConsumerContainer, EbiPortletContainerLocal

public interface EbiPortletContainer

This is the Base Portlet Container Interface. It performs run-time portlet operations by executing the operations on the specified active portlet.

Since:

v5.0

See Also:

EbiPortletEntity

Method Summary

String	getContainerType() Gets the container type for this portlet container instance.
EbiMarkupResponse	getMarkup(EbiPortalContext context, EbiPortletEntity entity, EbiMarkupParams mparams, EbiRuntimeContext runtimeContext) Renders a portlet instance specified by a EbiPortletEntity object, and return the markup fragment produced by this operation.
String	getPortletApplicationID() Gets the associated portlet application id (i.e.
void	init(ServletContext context) Initializes the portlet container.
EbiBlockingInteractionResponse	performBlockingInteraction(EbiPortalContext context, EbiPortletEntity entity, EbiMarkupParams mparams, EbiInteractionParams iparams) Processes a portlet action for a portlet instance specified by a EbiPortletEntity object.

Method Detail

getContainerType

public String getContainerType()

Gets the container type for this portlet container instance.

Returns:

the container type.

Since:

v5.0

getPortletApplicationID

public String getPortletApplicationID()

Gets the associated portlet application id (i.e. the WAR's context name).

Returns:

the identifier for the associated portlet application.

Since:

v5.0

init

public void init(ServletContext context)

Initializes the portlet container.

Parameters:

context - a ServletContext from the asscoiated portlet application.

Since:

v5.0

performBlockingInteraction

public EbiBlockingInteractionResponse performBlockingInteraction(EbiPortalContext context,
                                                                 EbiPortletEntity entity,
                                                                 EbiMarkupParams mparams,
                                                                 EbiInteractionParams iparams)
                                                          throws EboUnrecoverableSystemException,
                                                                 EboSecurityException,
                                                                 com.novell.afw.portlet.exception.EboPortletOperationException

Processes a portlet action for a portlet instance specified by a EbiPortletEntity object.

Parameters:

context - an EbiPortalContext object

entity - an EbiPortletEntity object

mparams - an EbiMarkupParams object

iparams - an EbiInteractionParams object

Returns:

a EbiBlockingInteractionResponse object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiMarkupParams, EbiInteractionParams, EbiBlockingInteractionResponse

getMarkup

public EbiMarkupResponse getMarkup(EbiPortalContext context,
                                   EbiPortletEntity entity,
                                   EbiMarkupParams mparams,
                                   EbiRuntimeContext runtimeContext)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException,
                                   com.novell.afw.portlet.exception.EboPortletOperationException

Renders a portlet instance specified by a EbiPortletEntity object, and return the markup fragment produced by this operation.

Parameters:

context - an EbiPortalContext object

entity - a EbiPortletEntity object

mparams - a EbiMarkupParams object

Returns:

a EbiMarkupResponse object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiMarkupParams, EbiMarkupResponse