Index

Object PCRE.PCREEngine


Variable Index

 o engineClosed
 
 o engineOpened
 
 o GV_DLL
 
 o GV_ENGINE
 

Method Index

 o CanClose()
Query the print engine to see if it is closeable.
 o clone()
PCREEngine objects are not clonable, this method simply throws an exception.
 o Close()
Close the print engine.
 o getAPI()
Get the PCREAPI object used by this engine.
 o getClient()
Get the client instance for this engine.
 o GetErrorCode()
Issue a PEGetErrorCode call.
 o GetErrorText()
Issue a PEGetErrorStr call.
 o GetHandleString(int, short, StringBuffer)
Issue a PEGetHandleString call.
 o getJobTable()
Get the job-table used by this engine.
 o getStatus()
Get the current engine status.
 o GetVersion(int)
Get the version of this report engine.
 o LogOffServer(String, PCRELogOnInfo)
Log off a database server.
 o LogOnServer(String, PCRELogOnInfo)
Log on to a database server.
 o Open()
Open a new print engine.
 o OpenJob(String)
Open a report using this engine
 o OpenSubreport(PCREJob, String)
Open a subreport within a job's current report.
 o PrintReport(String)
Print a given report
 o SendDataToFile(byte[], String, boolean)
Use Corba to send a character array to the server.

Field Detail

 o GV_DLL
int GV_DLL
 o GV_ENGINE
int GV_ENGINE
 o engineClosed
int engineClosed
 o engineOpened
int engineOpened

Method Detail

 o CanClose
boolean CanClose()
          Query the print engine to see if it is closeable.
 o clone
Object clone()
          PCREEngine objects are not clonable, this method simply throws an exception.
 o Close
void Close()
          Close the print engine.
 o getAPI
PCREAPI getAPI()
          Get the PCREAPI object used by this engine.
Returns:
An PCREAPI object.
 o getClient
PCREClient getClient()
          Get the client instance for this engine.
Returns:
The PCREClient for this engine.
 o GetErrorCode
short GetErrorCode()
          Issue a PEGetErrorCode call.
Returns:
The error code, or 0 on error
 o GetErrorText
String GetErrorText()
          Issue a PEGetErrorStr call.
Returns:
The error string, or an empty string on error ( not null )
 o GetHandleString
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.
 o getJobTable
PCREJobTable getJobTable()
          Get the job-table used by this engine.
Returns:
The table holding all currently open PCREAPI objects
 o getStatus
int getStatus()
          Get the current engine status.
Returns:
The current status code
 o GetVersion
short GetVersion(int versionRequested)
          Get the version of this report engine.
 o LogOffServer
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.
 o LogOnServer
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.
 o Open
boolean Open()
          Open a new print engine.
 o OpenJob
PCREJob OpenJob(String reportFileName)
          Open a report using this engine
Parameters:
reportFileName - The path and filename of the report file to open.
 o OpenSubreport
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.
 o PrintReport
void PrintReport(String reportFile)
          Print a given report
Parameters:
reportFile - The path and filename of the report file which is to be printed.
 o SendDataToFile
boolean SendDataToFile(byte data[],
                       String filename,
                       boolean overwrite)
          Use Corba to send a character array to the server. Should probably be turned into a PCRE Service.
Parameters:
data - char[]
filename - java.lang.String
overwrite - boolean
Returns:
boolean

Index