com.ail.core.document.generatedocument
Class RenderPdfDocumentService

java.lang.Object
  com.ail.core.Type
      com.ail.core.Service
          com.ail.core.document.generatedocument.RenderPdfDocumentService

All Implemented Interfaces:

ConfigurationOwner, CoreUser, java.io.Serializable, java.lang.Cloneable

public class RenderPdfDocumentService
extends Service

This class provides an implementation of the render document service which renders to PDF using Apache FOP.

The render options supported by this implementation match up one-to-one with those supported by the Apache FOP renderer:

• allowCopyContent
• allowEditContent
• allowEditAnnotations
• allowPrint
• userPassword
• ownerPassword

Specifying any of the above in RenderDocumentArg.getRenderOptionsArg() will result in the option being enabled. For example, the following will enable allowCopyContent and allowPrint options (setting them to "TRUE" in the Apache FOP):

command.setRenderOptionsArg("allowCopyContent=TRUE,allowPrint=TRUE,allowEditContent=FALSE");

Options not specified are set to FALSE by default.

Version:

$Revision$

Author:

$Author$

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ail.core.Type

jXPathContext, NOT_PERSISTED

Constructor Summary

RenderPdfDocumentService()
Default constructor

Method Summary

CommandArg	getArgs() Getter returning the arguments used by this entry point.
Core	getCore() Getter to fetch the entry point's code.
Version	getVersion() Fetch the version of this entry point.
void	invoke() The 'business logic' of the entry point.
void	setArgs(CommandArg args) Setter used to the set the entry points arguments.

Methods inherited from class com.ail.core.Service

getConfiguration, getConfigurationNamespace, getSecurityPrincipal, getVersionEffectiveDate, resetConfiguration, setConfiguration

Methods inherited from class com.ail.core.Type

addAttribute, clone, deleteLock, deleteSerialVersion, fetchJXPathContext, getAttribute, getAttribute, getAttributeCount, getForeignSystemId, getLock, getSerialVersion, getSystemId, hasLock, hasSerialVersion, hasSystemId, isPersisted, markAsNotPersisted, mergeWithDataFrom, removeAttribute, removeAttribute, setAttribute, setForeignSystemId, setLock, setSerialVersion, setSystemId, xpathGet, xpathGet, xpathIterate, xpathSet

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderPdfDocumentService

public RenderPdfDocumentService()

Default constructor

Method Detail

getCore

public Core getCore()

Getter to fetch the entry point's code. This method is demanded by the EntryPoint class.

Specified by:

getCore in class Service

Returns:

This entry point's instance of Core.

getVersion

public Version getVersion()

Fetch the version of this entry point.

Specified by:

getVersion in class Service

Returns:

A version object describing the version of this entry point.

setArgs

public void setArgs(CommandArg args)

Setter used to the set the entry points arguments.

Specified by:

setArgs in class Service

Parameters:

args - for invoke

getArgs

public CommandArg getArgs()

Getter returning the arguments used by this entry point.

Specified by:

getArgs in class Service

Returns:

An instance of GenerateDocumentArgs.

invoke

public void invoke()
            throws PreconditionException,
                   PostconditionException,
                   RenderException

The 'business logic' of the entry point.

Specified by:

invoke in class Service

Throws:

PreconditionException

PostconditionException

RenderException