com.dynalivery.word
Class WordEngine

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

public class WordEngine

extends HarmoniEngine

Fields inherited from class com.dynalivery.harmoni.HarmoniEngine

engineClosed, engineOpened

Constructor Summary

WordEngine(HarmoniClient client)
Construct a Harmoni Engine object.

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

Method Summary

boolean	Open() Open a new print engine.
WordJob	OpenJob(java.lang.String reportFileName) Open a report using this engine

Methods inherited from class com.dynalivery.harmoni.HarmoniEngine

clone, Close, getAPI, getClient, getJobTable, getStatus, GetVersion, LogOffServer, LogOnServer, OpenSaffronJob, PrintReport

Methods inherited from class java.lang.Object

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

Constructor Detail

WordEngine

public WordEngine(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.

WordEngine

public WordEngine(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

Open

public boolean Open()
             throws HarmoniServerError,
                    HarmoniAPIError

Open a new print engine.

Overrides:

Open in class HarmoniEngine

Throws:

HarmoniServerError - A fatal error occured during the remote call.

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

OpenJob

public WordJob OpenJob(java.lang.String reportFileName)
                throws HarmoniServerError,
                       HarmoniAPIError

Open a report using this engine

Parameters:

reportFileName - The path and filename of the report file to open.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

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