com.ail.core.document.generatedocument
Class RenderDocumentCommand

java.lang.Object
  com.ail.core.Type
      com.ail.core.command.AbstractCommand
          com.ail.core.command.Command
              com.ail.core.document.generatedocument.RenderDocumentCommand

All Implemented Interfaces:

CommandArg, RenderDocumentArg, java.io.Serializable, java.lang.Cloneable

public class RenderDocumentCommand
extends Command
implements RenderDocumentArg

Version:

$Revision$

Author:

$Author$

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ail.core.Type

jXPathContext, NOT_PERSISTED

Constructor Summary

RenderDocumentCommand()

Method Summary

CommandArg	getArgs() Get the argument set associated with this command.
byte[]	getRenderedDocumentRet() Get the rendered document.
java.lang.String	getRenderOptionsArg() Get the list of render service specific options which will applied during the render operation.
XMLString	getSourceDataArg() Get the XML data which the renderer will use as a source.
java.lang.String	getTranslationUrlArg()
void	setArgs(CommandArg arg) Update this Command object's arguments with those taken from the command arg passed in.
void	setRenderedDocumentRet(byte[] renderedDocumentRet)
void	setRenderOptionsArg(java.lang.String renderOptionsArg)
void	setSourceDataArg(XMLString sourceDataArg)
void	setTranslationUrlArg(java.lang.String translationUrlArg) Set the translation (if any) to be applied to the document pre-render.

Methods inherited from class com.ail.core.command.Command

clone, getAccessor, getCallersCore, getConfiguration, getVersion, invoke, setAccessor, setCallersCore, setConfiguration, setService

Methods inherited from class com.ail.core.Type

addAttribute, 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

Methods inherited from interface com.ail.core.command.CommandArg

getCallersCore, setCallersCore

Constructor Detail

RenderDocumentCommand

public RenderDocumentCommand()

Method Detail

setArgs

public void setArgs(CommandArg arg)

Description copied from class: AbstractCommand

Update this Command object's arguments with those taken from the command arg passed in. This is in effect a bulk setter. This interface will be implemented by beans that have many more getters/setters to support their properties. The implementations of this method take 'that', and pull all the relevant properties into this.

Specified by:

setArgs in class AbstractCommand

Parameters:

arg - Source for arguments

getArgs

public CommandArg getArgs()

Description copied from class: AbstractCommand

Get the argument set associated with this command.

Specified by:

getArgs in class AbstractCommand

Returns:

This objects arguments.

getSourceDataArg

public XMLString getSourceDataArg()

Get the XML data which the renderer will use as a source.

Specified by:

getSourceDataArg in interface RenderDocumentArg

Returns:

Source data

setSourceDataArg

public void setSourceDataArg(XMLString sourceDataArg)

Specified by:

setSourceDataArg in interface RenderDocumentArg

See Also:

RenderDocumentArg.getSourceDataArg()

getRenderOptionsArg

public java.lang.String getRenderOptionsArg()

Get the list of render service specific options which will applied during the render operation. See the javadocs associated with each type of render service for a list of the options supported, and a description of how the list is interpreted.

Specified by:

getRenderOptionsArg in interface RenderDocumentArg

Returns:

Comma separated list of options

setRenderOptionsArg

public void setRenderOptionsArg(java.lang.String renderOptionsArg)

Specified by:

setRenderOptionsArg in interface RenderDocumentArg

See Also:

RenderDocumentArg.getRenderOptionsArg()

getRenderedDocumentRet

public byte[] getRenderedDocumentRet()

Get the rendered document. This document is the result of the rendering process - a fully formed PDF, RTF, or whatever other format of file the implementing services support.

Specified by:

getRenderedDocumentRet in interface RenderDocumentArg

setRenderedDocumentRet

public void setRenderedDocumentRet(byte[] renderedDocumentRet)

Specified by:

setRenderedDocumentRet in interface RenderDocumentArg

See Also:

RenderDocumentArg.getRenderedDocumentRet()

getTranslationUrlArg

public java.lang.String getTranslationUrlArg()

Specified by:

getTranslationUrlArg in interface RenderDocumentArg

Returns:

translationUrlArg

See Also:

RenderDocumentArg.setTranslationUrlArg(String)

setTranslationUrlArg

public void setTranslationUrlArg(java.lang.String translationUrlArg)

Set the translation (if any) to be applied to the document pre-render. The interpretation of this argument is dependent on the render service implementation. See the javadocs associated with each render service for details of this option's usage.

Specified by:

setTranslationUrlArg in interface RenderDocumentArg

Parameters:

translationUrlArg - Translation URL