Index

Object PCRE.PCREClient

Variable Index

o PCRE_FAIL
Failure return code.
o PCRE_NAME
The default PCRE name
o PCRE_OK
Successful return code.
o priority
priority variable
o PRIORITY_HIGH
HIGH PRIORITY variable
o PRIORITY_LOW
LOW PRIORITY variable
o PRIORITY_MEDIUM
MEDIUM PRIORITY variable

Method Index

o Connect()
Connect client to selected PCRE services.
o Connect(boolean)
Connect client to selected PCRE services.
o Connected(String)
Is the Client is connected to named service.
o DisableScripting()
Disable event-driven scripting for this client.
o Disconnect()
Disconnect client from all PCRE services.
o EnableScripting()
Enable event-driven scripting for this client.
o GetAPI(String)
Get an API object from the registry.
o getApplet()
Return the applet hosting the client.
o getAppletHost()
If the client is running as an applet, return the host-name of the applet's code-base.
o getArchiveFileReturnOption()
Getter method for zipFlag member.
o getConfigServer()
Returns the config server object associated with this client.
o getConsole()
Return the client's console.
o getCustomServer()
Returns the custom server object associated with this client.
o getDefaultConsole()
Return the default console for the client.
o getDisableServerTimeout()
Getter method for disableServerTimeout flag.
o getGateway()
Returns the gateway server object associated with this client.
o getHost()
Return the PCRE client's host IP-address.
o getName()
Return the client's name.
o getORB()
Return the client orb.
o GetPrinterInfo(String, StringBuffer, PCREDEVMODE)
This method returns the printer Info given the Printer Name
o GetPrinterNames()
This method returns the names of the printers attached to the report server
o getPriority()
Getter method for priority member.
o getServer()
Returns the pcreserver object associated with this client.
o GetService(String)
Get a service from the client's registry.
o getSharedORB()
Get the shared ORB instance.
o getThreadConsole()
Return the console for the current thread.
o InvokeScript(PCREScripting, Event, Object)
Schedule a script triggered by the AWT event.
o isAppletClient()
Is the client is invoked in an applet?
o OpenEngine()
Acquire a print-engine for this client.
o OpenEngine(boolean)
Acquire and optionally open a print-engine for this client.
o PutAPI(String, Object)
Put an API object into the registry.
o PutService(PCREService)
Enter a PCRE service in the client's registry.
o Quit()
Short-hand for Quit(PCREClient.PCRE_OK).
o Quit(int)
Disconnect client from all PCRE services.
o RemoveAPI(String)
Remove an API object from the registry.
o RemoveService(String)
Remove a service from the client's registry.
o ResetReportServer(PCREReportServerInfo)
 
o SelectReportServer(String)
Use the Load balancer to select a Gateway by the given method.
o setArchiveFileReturnOption(boolean)
Setter method for zipFlag member.
o setConfigServer(PCREConfigServer)
Sets the config server object associated with this client.
o setCustomServer(PCRECustomServer)
Sets the custom server object associated with this client.
o setDefaultConsole(PCREConsole)
Set the default console for the client.
o setDisableServerTimeout(boolean)
Setter method for disableServerTimeout flag.
o setGatewayServer(PCREGateway)
Sets the gateway server object associated with this client.
o setName(String)
Set the client's name.
o setPriority(int)
Setter method for priority member.
o setReportEngineServer(PCREServer)
Sets the pcreserver object associated with this client.
o setSharedORB(ORB)
Set the shared ORB instance.
o setThreadConsole(PCREConsole)
Set the console for the current thread.
o Terminate()
Short-hand for Terminate(PCRE_FAIL);
o Terminate(int)
Terminate the client application.

Field Detail

o PCRE_OK
int PCRE_OK
          Successful return code.
o PCRE_FAIL
int PCRE_FAIL
          Failure return code.
o PCRE_NAME
String PCRE_NAME
          The default PCRE name
o PRIORITY_HIGH
int PRIORITY_HIGH
          HIGH PRIORITY variable
o PRIORITY_MEDIUM
int PRIORITY_MEDIUM
          MEDIUM PRIORITY variable
o PRIORITY_LOW
int PRIORITY_LOW
          LOW PRIORITY variable
o priority
int priority
          priority variable

Method Detail

o Connect
void Connect()
          Connect client to selected PCRE services. Clients should override.
o Connect
void Connect(boolean useLoadBalancer)
          Connect client to selected PCRE services. Clients should override.
Parameters:
useLoadBalancer - Boolean value used to connect a report server via a load balancer.
o Connected
boolean Connected(String name)
          Is the Client is connected to named service. Clients may override.
Parameters:
name - The name of the service to test for.
Returns:
True if connected, false otherwise.F
o DisableScripting
void DisableScripting()
          Disable event-driven scripting for this client.
o Disconnect
void Disconnect()
          Disconnect client from all PCRE services. Clients may override.
o EnableScripting
void EnableScripting()
          Enable event-driven scripting for this client.
o GetAPI
Object GetAPI(String name)
          Get an API object from the registry.
Parameters:
name - The name of the object to be retrieved.
Returns:
The API object.
o getApplet
Applet getApplet()
          Return the applet hosting the client.
Returns:
The applet the client is running in.
o getAppletHost
String getAppletHost()
          If the client is running as an applet, return the host-name of the applet's code-base. Return null if the client is not running as an applet.
Returns:
The applets hostname or null on error.
o getConfigServer
PCREConfigServer getConfigServer()
          Returns the config server object associated with this client.
Returns:
com.dynalivery.pcre.PCREConfigServer
o getConsole
PCREConsole getConsole()
          Return the client's console.
Returns:
The client's console.
o getCustomServer
PCRECustomServer getCustomServer()
          Returns the custom server object associated with this client.
Returns:
com.dynalivery.pcre.PCRECustomServer
o getDefaultConsole
PCREConsole getDefaultConsole()
          Return the default console for the client.
Returns:
The default console.
o getGateway
PCREGateway getGateway()
          Returns the gateway server object associated with this client.
Returns:
com.dynalivery.pcre.PCREGateway
o getHost
String getHost()
          Return the PCRE client's host IP-address. Return null if the address cannot be derived.
Returns:
The host IP-address, or null on error.
o getName
String getName()
          Return the client's name.
Returns:
The clients name.
o getORB
ORB getORB()
          Return the client orb.
Returns:
The orb in use.
o GetPrinterInfo
String[] GetPrinterInfo(String printerName,
                        StringBuffer driverName,
                        PCREDEVMODE devMode)
          This method returns the printer Info given the Printer Name
Parameters:
printerName, - Name of the Printer as String
driverName, - Holds the Driver Name of the Printer Name given as input
pcreMode, - Holds the PCREDEVMODE of this Printer
Returns:
String[], the String array consists of set of ports supported by this printer
o GetPrinterNames
String[] GetPrinterNames()
          This method returns the names of the printers attached to the report server
o getServer
PCREServer getServer()
          Returns the pcreserver object associated with this client.
Returns:
com.dynalivery.pcre.PCREServer
o GetService
PCREService GetService(String name)
          Get a service from the client's registry.
Parameters:
name - The name of the service requested.
Returns:
The matching service, or null on error.
o getThreadConsole
PCREConsole getThreadConsole()
          Return the console for the current thread.
Returns:
The console associated with the current thread.
o InvokeScript
void InvokeScript(PCREScripting script,
                  Event evt,
                  Object arg)
          Schedule a script triggered by the AWT event.
o isAppletClient
boolean isAppletClient()
          Is the client is invoked in an applet?
Returns:
True if the client is inside an applet, False otherwise.
o OpenEngine
PCREEngine OpenEngine()
          Acquire a print-engine for this client.
Returns:
The new PCREEngine object.
o OpenEngine
PCREEngine OpenEngine(boolean open)
          Acquire and optionally open a print-engine for this client.
Parameters:
open - If true, open the print-engine on the server.
Returns:
The PCREEngine.
o PutAPI
void PutAPI(String name,
            Object api)
          Put an API object into the registry.
Parameters:
name - The name of the API object.
api - The API object to be entered.
o PutService
void PutService(PCREService service)
          Enter a PCRE service in the client's registry. Also creates a link to this client from the service.
Parameters:
service - The service that is going to be used.
o Quit
void Quit()
          Short-hand for Quit(PCREClient.PCRE_OK).
o Quit
void Quit(int code)
          Disconnect client from all PCRE services. Clients should override.
Parameters:
code - The termination code.
o RemoveAPI
void RemoveAPI(String name)
          Remove an API object from the registry.
Parameters:
name - The name of the API object to be removed.
o RemoveService
void RemoveService(String name)
          Remove a service from the client's registry.
Parameters:
name - The name of the service to remove.
o ResetReportServer
void ResetReportServer(PCREReportServerInfo rsinfo)
o SelectReportServer
void SelectReportServer(String method)
          Use the Load balancer to select a Gateway by the given method.
o setConfigServer
void setConfigServer(PCREConfigServer newConfigServer)
          Sets the config server object associated with this client.
Parameters:
newConfigServer - com.dynalivery.pcre.PCREConfigServer
o setCustomServer
void setCustomServer(PCRECustomServer newCustomServer)
          Sets the custom server object associated with this client.
Parameters:
newCustomServer - com.dynalivery.pcre.PCRECustomServer
o setDefaultConsole
void setDefaultConsole(PCREConsole console)
          Set the default console for the client.
Parameters:
console - The new console for this client.
o setGatewayServer
void setGatewayServer(PCREGateway newGatewayServer)
          Sets the gateway server object associated with this client.
Parameters:
newGatewayServer - com.dynalivery.pcre.PCREGateway
o setName
void setName(String name)
          Set the client's name.
Parameters:
name - The new name for this client.
o setReportEngineServer
void setReportEngineServer(PCREServer newReportEngineServer)
          Sets the pcreserver object associated with this client.
Parameters:
newReportEngineServer - com.dynalivery.pcre.PCREServer
o setThreadConsole
void setThreadConsole(PCREConsole console)
          Set the console for the current thread.
Parameters:
console - The new console to associate with this thread.
o Terminate
void Terminate()
          Short-hand for Terminate(PCRE_FAIL);
o Terminate
void Terminate(int code)
          Terminate the client application.
Parameters:
code - The termination code.
o setPriority
void setPriority(int clientPriority)
          Setter method for priority member.
Parameters:
clientPriority - static integer variable
o getPriority
int getPriority()
          Getter method for priority member.
Returns:
priority member
o setArchiveFileReturnOption
void setArchiveFileReturnOption(boolean zipOption)
          Setter method for zipFlag member.
Parameters:
zipOption - boolean
o getArchiveFileReturnOption
boolean getArchiveFileReturnOption()
          Getter method for zipFlag member.
Returns:
zipFlag member
o setDisableServerTimeout
void setDisableServerTimeout(boolean timeoutFlag)
          Setter method for disableServerTimeout flag.
Parameters:
disableServerTimeout - boolean
o getDisableServerTimeout
boolean getDisableServerTimeout()
          Getter method for disableServerTimeout flag.
Returns:
disableServerTimeout member
o getSharedORB
ORB getSharedORB()
          Get the shared ORB instance.
Returns:
shrOrb
o setSharedORB
void setSharedORB(ORB theSharedORB)
          Set the shared ORB instance.
Parameters:
org.omg.CORBA.ORB - 
Index