com.ail.core.document.generatedocument
Interface RenderDocumentArg

All Superinterfaces:

CommandArg, java.io.Serializable

All Known Implementing Classes:

RenderDocumentArgImp, RenderDocumentCommand

public interface RenderDocumentArg
extends CommandArg

Version:

$Revision$

Author:

$Author$

Method Summary

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	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 interface com.ail.core.command.CommandArg

getCallersCore, setCallersCore

Method Detail

getSourceDataArg

XMLString getSourceDataArg()

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

Returns:

Source data

setSourceDataArg

void setSourceDataArg(XMLString sourceDataArg)

Parameters:

sourceDataArg -

See Also:

getSourceDataArg()

getRenderedDocumentRet

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.

setRenderedDocumentRet

void setRenderedDocumentRet(byte[] renderedDocumentRet)

Parameters:

renderedDocumentRet -

See Also:

getRenderedDocumentRet()

getRenderOptionsArg

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.

Returns:

Comma separated list of options

setRenderOptionsArg

void setRenderOptionsArg(java.lang.String renderOptionsArg)

Parameters:

renderOptionsArg -

See Also:

getRenderOptionsArg()

setTranslationUrlArg

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.

Parameters:

translationUrlArg - Translation URL

getTranslationUrlArg

java.lang.String getTranslationUrlArg()

Returns:

translationUrlArg

See Also:

setTranslationUrlArg(String)