com.dynalivery.harmoni
Class FormatOptions

java.lang.Object
  |
  +--com.dynalivery.harmoni.FormatOptions

Direct Known Subclasses:

HTMLFormatOptions, PDFFormatOptions, RasterFormatOptions, RTFFormatOptions, SVGFormatOptions

public abstract class FormatOptions

extends java.lang.Object

implements java.io.Serializable

This class defines the formatting options for a Saffron export.

See Also:

Serialized Form

Constructor Summary

FormatOptions(int fileType)
Creates new FormatOptions

Method Summary

int	getFileType() Returns the output file type (e.g.
abstract byte[]	getXML() Returns an XML String representation of the format options, if any
void	setFileType(int fileType) Sets the output file type
java.lang.String	toString() Creates display string for format options.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatOptions

public FormatOptions(int fileType)
              throws InvalidParameterException

Creates new FormatOptions

Parameters:

fileType - the output file type (e.g. FileType.PDF)

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

Method Detail

getFileType

public int getFileType()

Returns the output file type (e.g. FileType.PDF)

Returns:

the output file type (e.g. FileType.PDF)

setFileType

public void setFileType(int fileType)
                 throws InvalidParameterException

Sets the output file type

Parameters:

fileType - the output file type (e.g. FileType.PDF)

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

getXML

public abstract byte[] getXML()
                       throws InvalidParameterException

Returns an XML String representation of the format options, if any

Returns:

an XML String representation of the format options, if any

Throws:

com.dynalivery.saffron.client.exception.InvalidParameterException -

toString

public java.lang.String toString()

Creates display string for format options. Must be overridden in subclasses.

Overrides:

toString in class java.lang.Object

Returns:

display string for format options. Must be overridden in subclasses.