Index

Object PCRE.PCREEngine

engineClosed

 

engineOpened

 

GV_DLL

 

GV_ENGINE

 

CanClose()

Query the print engine to see if it is closeable.

clone()

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

Close()

Close the print engine.

getAPI()

Get the PCREAPI object used by this engine.

getClient()

Get the client instance for this engine.

GetErrorCode()

Issue a PEGetErrorCode call.

GetErrorText()

Issue a PEGetErrorStr call.

GetHandleString(int, short, StringBuffer)

Issue a PEGetHandleString call.

getJobTable()

Get the job-table used by this engine.

getStatus()

Get the current engine status.

GetVersion(int)

Get the version of this report engine.

logOffRepository()

Should be called to release resources after the user is finished using the repository from this PCREEngine object and all PCREJob objects associated with this PCREEngine.

LogOffServer(String, PCRELogOnInfo)

Log off a database server.

logOnRepository(String, String)

Used to log this PCREEngine object and any PCREJob object created with this PCREEngine onto the repository.

LogOnServer(String, PCRELogOnInfo)

Log on to a database server.

Open()

Open a new print engine.

OpenJob(String)

Open a report using this engine

OpenJobFromRepository(String)

Similar to the OpenJob method call except the report template is retrieved from the repository instead of the file system of the report server.

OpenSaffronJob()

Get an instance of PCRESaffronJob

OpenSubreport(PCREJob, String)

Open a subreport within a job's current report.

PrintReport(String)

Print a given report

int GV_DLL

int GV_ENGINE

int engineClosed

int engineOpened

boolean CanClose()

          Query the print engine to see if it is closeable.

Object clone()

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

void Close()

          Close the print engine.

PCREAPI getAPI()

          Get the PCREAPI object used by this engine.

Returns:

An PCREAPI object.

PCREClient getClient()

          Get the client instance for this engine.

Returns:

The PCREClient for this engine.

short GetErrorCode()

          Issue a PEGetErrorCode call.

Returns:

The error code, or 0 on error

String GetErrorText()

          Issue a PEGetErrorStr call.

Returns:

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

boolean GetHandleString(int textHandle,
                        short textLength,
                        StringBuffer string)

          Issue a PEGetHandleString call.

Parameters:

textHandle - The handle of the string to retrieve.

textLength - The length of the text.

string - A buffer to store the result into.

Returns:

True on success, False on error.

PCREJobTable getJobTable()

          Get the job-table used by this engine.

Returns:

The table holding all currently open PCREAPI objects

int getStatus()

          Get the current engine status.

Returns:

The current status code

short GetVersion(int versionRequested)

          Get the version of this report engine.

boolean LogOffServer(String dllName,
                     PCRELogOnInfo logOnInfo)

          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.

boolean LogOnServer(String dllName,
                    PCRELogOnInfo logOnInfo)

          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.

boolean Open()

          Open a new print engine.

PCREJob OpenJob(String reportFileName)

          Open a report using this engine

Parameters:

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

PCRESaffronJob OpenSaffronJob()

          Get an instance of PCRESaffronJob

PCREJob OpenSubreport(PCREJob parentJob,
                      String subreportName)

          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.

void PrintReport(String reportFile)

          Print a given report

Parameters:

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

void logOnRepository(String username,
                     String password)

          Used to log this PCREEngine object and any PCREJob object created with this PCREEngine onto the repository. Only one user can be logged on per PCREEngine object. If this method is called after a successful login, then the current user will be logged out and the new user will attempt to log on to the repository.

Parameters:

username - a user which exists in the security realm of the Web Application Server which is running the repository.

password - the password corresponding to the username given

void logOffRepository()

          Should be called to release resources after the user is finished using the repository from this PCREEngine object and all PCREJob objects associated with this PCREEngine.

PCREJob OpenJobFromRepository(String repositoryPath)

          Similar to the OpenJob method call except the report template is retrieved from the repository instead of the file system of the report server.

Parameters:

repositoryPath - the full path to the report template in the repository.

Index