Package com.aquima.interactions.portal.documents.model

Class RenderedDocument

java.lang.Object

com.aquima.interactions.portal.documents.model.RenderedDocument

All Implemented Interfaces:

IRenderedDocument, Serializable

public class RenderedDocument
extends Object
implements IRenderedDocument

This class is used to return a rendered document.

Since:

6.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RenderedDocument(String name, String description, OutputFormat format, byte[] contents)	Constructor to create a generated document.

Method Summary

Modifier and Type	Method	Description
byte[]	getContents()	This method returns the actual contents of the generated document.
String	getDescription()	This method returns a descriptive text of the document.
String	getName()	This method returns the name of the document.
OutputFormat	getOutputFormat()	This method returns the output format of the document.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RenderedDocument

public RenderedDocument(String name,
 String description,
 OutputFormat format,
 byte[] contents)

Constructor to create a generated document.

Parameters:

name - The name of the document, may not be null or empty.

description - The description of the document, may be null.

format - The output format of the document, may not be null.

contents - The binary content of the document, may not be null.

Method Details

getName

public String getName()

Description copied from interface: IRenderedDocument

This method returns the name of the document.

Specified by:

getName in interface IRenderedDocument

Returns:

The name of the document.

getDescription

public String getDescription()

Description copied from interface: IRenderedDocument

This method returns a descriptive text of the document.

Specified by:

getDescription in interface IRenderedDocument

Returns:

a descriptive text of the document, may be null

getOutputFormat

public OutputFormat getOutputFormat()

Description copied from interface: IRenderedDocument

This method returns the output format of the document.

Specified by:

getOutputFormat in interface IRenderedDocument

Returns:

The output format of the document.

getContents

public byte[] getContents()

Description copied from interface: IRenderedDocument

This method returns the actual contents of the generated document.

Specified by:

getContents in interface IRenderedDocument

Returns:

byte array containing the actual content of the document.

toString

public String toString()

Overrides:

toString in class Object