Package com.aquima.interactions.framework.handler.document

Class GenerateDocumentHandler

java.lang.Object

com.aquima.interactions.framework.handler.document.GenerateDocumentHandler

All Implemented Interfaces:

IActionHandler

public class GenerateDocumentHandler
extends Object
implements IActionHandler

This document handler generates a document with the current portal context.

Since 7.0 this action handler also support document generation of pages.

It expects the following parameters:

• document-name/page-name: name of the document or page to generate.
• output-format: output format of the document to generate (String or OutputFormat).
• language-code: code of the language to be used for document generation.

It returns an instance of nl.everest.framework.handler.document.DocumentResult containing the renderer document.

Since:

6.0

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_DOCUMENT_NAME
static final String	ATTRIBUTE_LANGUAGE_CODE
static final String	ATTRIBUTE_OUTPUT_FORMAT
static final String	ATTRIBUTE_PAGE_NAME
static final String	NAME	This field defines the default name of the handler.

Constructor Summary

Constructors

Constructor	Description
GenerateDocumentHandler()

Method Summary

Modifier and Type	Method	Description
IActionResult	generateDocument(IPortalContext context)
IActionResult	handle(IActionContext context)	This method will be called from the portal session to handle an action request from the client.
boolean	isReadOnly()	This method indicates if the action handler does not modify any profile data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

This field defines the default name of the handler.

See Also:

• Constant Field Values

ATTRIBUTE_DOCUMENT_NAME

public static final String ATTRIBUTE_DOCUMENT_NAME

See Also:

• Constant Field Values

ATTRIBUTE_PAGE_NAME

public static final String ATTRIBUTE_PAGE_NAME

See Also:

• Constant Field Values

ATTRIBUTE_OUTPUT_FORMAT

public static final String ATTRIBUTE_OUTPUT_FORMAT

See Also:

• Constant Field Values

ATTRIBUTE_LANGUAGE_CODE

public static final String ATTRIBUTE_LANGUAGE_CODE

See Also:

• Constant Field Values

Constructor Details

GenerateDocumentHandler

public GenerateDocumentHandler()

Method Details

handle

public IActionResult handle(IActionContext context)
                     throws Exception

Description copied from interface: IActionHandler

This method will be called from the portal session to handle an action request from the client. The method returns an Action result object which can be used by the client to act upon this result.

Specified by:

handle in interface IActionHandler

Parameters:

context - The portal context of the current session.

Returns:

The result of the handle method, may be null.

Throws:

Exception - When an unexpected exception occurs.

generateDocument

public IActionResult generateDocument(IPortalContext context)
                               throws Exception

Throws:

Exception

isReadOnly

public boolean isReadOnly()

Description copied from interface: IActionHandler

This method indicates if the action handler does not modify any profile data.

Specified by:

isReadOnly in interface IActionHandler

Returns:

boolean indicating if the handler does not modify any profile data.