com.dynalivery.harmoni
Class HarmoniEngine

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

Direct Known Subclasses:

PCREEngine, WordEngine

public abstract class HarmoniEngine

extends java.lang.Object

Field Summary

static int	engineClosed
static int	engineOpened

Constructor Summary

HarmoniEngine(HarmoniClient client)
Construct a Harmoni Engine object.

HarmoniEngine(HarmoniClient client, boolean open)
Construct a Harmoni Engine object and optionally call OpenEngine.

Method Summary

java.lang.Object	clone() HarmoniEngine objects are not clonable, this method simply throws an exception.
void	Close() Close the print engine.
HarmoniAPI	getAPI() Get the HarmoniAPI object used by this engine.
HarmoniClient	getClient() Get the client instance for this engine.
HarmoniJobTable	getJobTable() Get the job-table used by this engine.
int	getStatus() Get the current engine status.
short	GetVersion(int versionRequested) Get the version of this report engine.
boolean	LogOffServer(java.lang.String dllName, HarmoniLogOnInfo logOnInfo) Log off a database server.
boolean	LogOnServer(java.lang.String dllName, HarmoniLogOnInfo logOnInfo) Log on to a database server.
boolean	Open() Open a new print engine.
HarmoniSaffronJob	OpenSaffronJob() Get an instance of HarmoniSaffronJob
void	PrintReport(java.lang.String reportFile) Print a given report

Methods inherited from class java.lang.Object

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

Field Detail

engineClosed

public static final int engineClosed

engineOpened

public static final int engineOpened

Constructor Detail

HarmoniEngine

public HarmoniEngine(HarmoniClient client)
              throws HarmoniClientError,
                     HarmoniServerError,
                     HarmoniAPIError

Construct a Harmoni Engine object.

Parameters:

client - The HarmoniClient object that holds the Harmoni server connection.

Throws:

HarmoniClientError - The HarmoniClient object is not conntected to the Harmoni server.

HarmoniServerError - A fatal error occurred during the remote call.

HarmoniAPIError - The remote OpenEngine call returned a value indicating failure.

HarmoniEngine

public HarmoniEngine(HarmoniClient client,
                     boolean open)
              throws HarmoniClientError,
                     HarmoniServerError,
                     HarmoniAPIError

Construct a Harmoni Engine object and optionally call OpenEngine.

Parameters:

client - The HarmoniClient object that holds the Harmoni server connection.

open - If true, call OpenEngine to open the print engine.

Throws:

HarmoniClientError - The HarmoniClient object is not connected to the Harmoni server.

HarmoniServerError - A fatal error occurred during the remote call.

HarmoniAPIError - The remote OpenEngine call returned a value indicating failure.

Method Detail

clone

public final java.lang.Object clone()
                             throws java.lang.CloneNotSupportedException

HarmoniEngine objects are not clonable, this method simply throws an exception.

Throws:

java.lang.CloneNotSupportedException - Indicates that cloning is not supported.

Close

public void Close()
           throws HarmoniServerError,
                  HarmoniAPIError

Close the print engine.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

getAPI

public HarmoniAPI getAPI()

Get the HarmoniAPI object used by this engine.

Returns:

An HarmoniAPI object.

getClient

public HarmoniClient getClient()

Get the client instance for this engine.

Returns:

The HarmoniClient for this engine.

getJobTable

public HarmoniJobTable getJobTable()

Get the job-table used by this engine.

Returns:

The table holding all currently open HarmoniAPI objects

getStatus

public int getStatus()

Get the current engine status.

Returns:

The current status code

GetVersion

public short GetVersion(int versionRequested)
                 throws HarmoniServerError,
                        HarmoniAPIError

Get the version of this report engine.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

LogOffServer

public boolean LogOffServer(java.lang.String dllName,
                            HarmoniLogOnInfo logOnInfo)
                     throws HarmoniServerError,
                            HarmoniAPIError

Log off a database server.

Parameters:

dllName - The DLL to use for the data source which you wish to log off.

logOnInfo - The login information to use for logging off the database.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

LogOnServer

public boolean LogOnServer(java.lang.String dllName,
                           HarmoniLogOnInfo logOnInfo)
                    throws HarmoniServerError,
                           HarmoniAPIError

Log on to a database server.

Parameters:

dllName - The DLL to use for the data source which you wish to log on to.

logOnInfo - The login information to use.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

Open

public boolean Open()
             throws HarmoniServerError,
                    HarmoniAPIError

Open a new print engine.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

OpenSaffronJob

public HarmoniSaffronJob OpenSaffronJob()
                                 throws HarmoniServerError,
                                        HarmoniAPIError

Get an instance of HarmoniSaffronJob

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.

PrintReport

public void PrintReport(java.lang.String reportFile)
                 throws HarmoniServerError,
                        HarmoniAPIError

Print a given report

Parameters:

reportFile - The path and filename of the report file which is to be printed.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

HarmoniAPIError - The remote print engine call returned a value indicating failure.