com.dynalivery.crystal
Class PCREEngine

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

public class PCREEngine

extends HarmoniEngine

Field Summary

static int	GV_DLL
static int	GV_ENGINE

Fields inherited from class com.dynalivery.harmoni.HarmoniEngine

engineClosed, engineOpened

Constructor Summary

PCREEngine(HarmoniClient client)
Construct a Harmoni Engine object.

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

Method Summary

boolean	CanClose() Query the print engine to see if it is closeable.
short	GetErrorCode() Issue a PEGetErrorCode call.
java.lang.String	GetErrorText() Issue a PEGetErrorStr call.
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.
PCREJob	OpenJob(java.lang.String reportFileName) Open a report using this engine
PCREJob	OpenSubreport(PCREJob parentJob, java.lang.String subreportName) Open a subreport within a job's current report.

Methods inherited from class com.dynalivery.harmoni.HarmoniEngine

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

Methods inherited from class java.lang.Object

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

Field Detail

GV_DLL

public static final int GV_DLL

GV_ENGINE

public static final int GV_ENGINE

Constructor Detail

PCREEngine

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

PCREEngine

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

GetErrorCode

public short GetErrorCode()
                   throws HarmoniServerError,
                          HarmoniAPIError

Issue a PEGetErrorCode call.

Returns:

The error code, or 0 on error

Throws:

HarmoniServerError - A fatal error occurred during the remote call.

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

GetErrorText

public java.lang.String GetErrorText()
                              throws HarmoniServerError,
                                     HarmoniAPIError

Issue a PEGetErrorStr call.

Returns:

The error string, or an empty string on error ( not null )

Throws:

HarmoniServerError - A fatal error occurred during the remote call.

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

LogOffServer

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

Log off a database server.

Overrides:

LogOffServer in class HarmoniEngine

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.

Overrides:

LogOnServer in class HarmoniEngine

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.

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.

CanClose

public boolean CanClose()
                 throws HarmoniServerError,
                        HarmoniAPIError

Query the print engine to see if it is closeable.

Throws:

HarmoniServerError - A fatal error occured during the remote call.

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

OpenJob

public PCREJob 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.

OpenSubreport

public PCREJob OpenSubreport(PCREJob parentJob,
                             java.lang.String subreportName)
                      throws HarmoniServerError,
                             HarmoniAPIError

Open a subreport within a job's current report.

Parameters:

parentJob - The job associated with the report containing the subreport.

subreportName - The name of the subreport within parentJob's report.

Throws:

PCREServerError - A fatal error occured during the remote call.

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