com.webmethods.portal.framework.presentation

Interface IPresentationHandler

All Superinterfaces:

IComponent, IHandler, IInitializable, ISystemHandler

public interface IPresentationHandler
extends IHandler

The IComponent for the IPresentationManager

Method Summary

Modifier and Type	Method and Description
boolean	canReturnContent() Returns whether the render(com.webmethods.portal.framework.presentation.IPresentationData) method can return not null Reader.
void	handle(HttpServletRequest request, HttpServletResponse response) Handles the presentation concepts of the request.
Reader	render(IPresentationData pdo) Renders the resource specified by the presentation data object.
Reader	render(IPresentationData pdo, boolean grabOutput) Renders the resource specified by the presentation data object.

Methods inherited from interface com.webmethods.portal.framework.IHandler

getConfigElem, getHandlerBean, getName, getPerfToken, initialize, postInitialize, shutdown

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

Method Detail

handle

void handle(HttpServletRequest request,
            HttpServletResponse response)
     throws FrameworkException

Handles the presentation concepts of the request. Please note, their should be a PresentationData available with the request.

Parameters:

request - the HttpServletRequest for this session

response - the HttpServletResponse for this session

Throws:

FrameworkException

See Also:

PresentationData.getPresentationData(javax.servlet.http.HttpServletRequest)

render

Reader render(IPresentationData pdo)
       throws FrameworkException

Renders the resource specified by the presentation data object.

Parameters:

pdo - The presentation data object that contains information used by the rendering process.

Returns:

A reader containing the rendered bits. Never null.

Throws:

FrameworkException

render

Reader render(IPresentationData pdo,
              boolean grabOutput)
       throws FrameworkException

Renders the resource specified by the presentation data object.

Parameters:

pdo - The presentation data object that contains information used by the rendering process.

Returns:

always NULL if grabOutput is false, otherwise never NULL

Throws:

FrameworkException

canReturnContent

boolean canReturnContent()
                  throws FrameworkException

Returns whether the render(com.webmethods.portal.framework.presentation.IPresentationData) method can return not null Reader.

Returns:

true if the render(com.webmethods.portal.framework.presentation.IPresentationData) method can return not null Reader

Throws:

FrameworkException