Index

Object PCRE.PCREClient

PCRE_FAIL

Failure return code.

PCRE_NAME

The default PCRE name

PCRE_OK

Successful return code.

Connect()

Connect client to selected PCRE services.

Connect(boolean)

Connect client to selected PCRE services.

Connected(String)

Is the Client is connected to named service.

DisableScripting()

Disable event-driven scripting for this client.

Disconnect()

Disconnect client from all PCRE services.

EnableScripting()

Enable event-driven scripting for this client.

GetAPI(String)

Get an API object from the registry.

getApplet()

Return the applet hosting the client.

getAppletHost()

If the client is running as an applet, return the host-name of the applet's code-base.

getConfigServer()

Returns the config server object associated with this client.

getConsole()

Return the client's console.

getCustomServer()

Returns the custom server object associated with this client.

getDefaultConsole()

Return the default console for the client.

getGateway()

Returns the gateway server object associated with this client.

getHost()

Return the PCRE client's host IP-address.

getName()

Return the client's name.

getORB()

Return the client orb.

GetPrinterInfo(String, StringBuffer, PCREDEVMODE)

This method returns the printer Info given the Printer Name

GetPrinterNames()

This method returns the names of the printers attached to the report server

getServer()

Returns the pcreserver object associated with this client.

GetService(String)

Get a service from the client's registry.

getThreadConsole()

Return the console for the current thread.

InvokeScript(PCREScripting, Event, Object)

Schedule a script triggered by the AWT event.

isAppletClient()

Is the client is invoked in an applet?

OpenEngine()

Acquire a print-engine for this client.

OpenEngine(boolean)

Acquire and optionally open a print-engine for this client.

PutAPI(String, Object)

Put an API object into the registry.

PutService(PCREService)

Enter a PCRE service in the client's registry.

Quit()

Short-hand for Quit(PCREClient.PCRE_OK).

Quit(int)

Disconnect client from all PCRE services.

RemoveAPI(String)

Remove an API object from the registry.

RemoveService(String)

Remove a service from the client's registry.

ResetReportServer(PCREReportServerInfo)

 

SelectReportServer(String)

Use the Load balancer to select a Gateway by the given method.

setConfigServer(PCREConfigServer)

Sets the config server object associated with this client.

setCustomServer(PCRECustomServer)

Sets the custom server object associated with this client.

setDefaultConsole(PCREConsole)

Set the default console for the client.

setGatewayServer(PCREGateway)

Sets the gateway server object associated with this client.

setName(String)

Set the client's name.

setReportEngineServer(PCREServer)

Sets the pcreserver object associated with this client.

setThreadConsole(PCREConsole)

Set the console for the current thread.

Terminate()

Short-hand for Terminate(PCRE_FAIL);

Terminate(int)

Terminate the client application.

int PCRE_OK

          Successful return code.

int PCRE_FAIL

          Failure return code.

String PCRE_NAME

          The default PCRE name

void Connect()

          Connect client to selected PCRE services. Clients should override.

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.

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

void DisableScripting()

          Disable event-driven scripting for this client.

void Disconnect()

          Disconnect client from all PCRE services. Clients may override.

void EnableScripting()

          Enable event-driven scripting for this client.

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.

Applet getApplet()

          Return the applet hosting the client.

Returns:

The applet the client is running in.

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.

PCREConfigServer getConfigServer()

          Returns the config server object associated with this client.

Returns:

com.mobileapps.pcre.PCREConfigServer

PCREConsole getConsole()

          Return the client's console.

Returns:

The client's console.

PCRECustomServer getCustomServer()

          Returns the custom server object associated with this client.

Returns:

com.mobileapps.pcre.PCRECustomServer

PCREConsole getDefaultConsole()

          Return the default console for the client.

Returns:

The default console.

PCREGateway getGateway()

          Returns the gateway server object associated with this client.

Returns:

com.mobileapps.pcre.PCREGateway

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.

String getName()

          Return the client's name.

Returns:

The clients name.

ORB getORB()

          Return the client orb.

Returns:

The orb in use.

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

String[] GetPrinterNames()

          This method returns the names of the printers attached to the report server

PCREServer getServer()

          Returns the pcreserver object associated with this client.

Returns:

com.mobileapps.pcre.PCREServer

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.

PCREConsole getThreadConsole()

          Return the console for the current thread.

Returns:

The console associated with the current thread.

void InvokeScript(PCREScripting script,
                  Event evt,
                  Object arg)

          Schedule a script triggered by the AWT event.

boolean isAppletClient()

          Is the client is invoked in an applet?

Returns:

True if the client is inside an applet, False otherwise.

PCREEngine OpenEngine()

          Acquire a print-engine for this client.

Returns:

The new PCREEngine object.

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.

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.

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.

void Quit()

          Short-hand for Quit(PCREClient.PCRE_OK).

void Quit(int code)

          Disconnect client from all PCRE services. Clients should override.

Parameters:

code - The termination code.

void RemoveAPI(String name)

          Remove an API object from the registry.

Parameters:

name - The name of the API object to be removed.

void RemoveService(String name)

          Remove a service from the client's registry.

Parameters:

name - The name of the service to remove.

void ResetReportServer(PCREReportServerInfo rsinfo)

void SelectReportServer(String method)

          Use the Load balancer to select a Gateway by the given method.

void setConfigServer(PCREConfigServer newConfigServer)

          Sets the config server object associated with this client.

Parameters:

newConfigServer - com.mobileapps.pcre.PCREConfigServer

void setCustomServer(PCRECustomServer newCustomServer)

          Sets the custom server object associated with this client.

Parameters:

newCustomServer - com.mobileapps.pcre.PCRECustomServer

void setDefaultConsole(PCREConsole console)

          Set the default console for the client.

Parameters:

console - The new console for this client.

void setGatewayServer(PCREGateway newGatewayServer)

          Sets the gateway server object associated with this client.

Parameters:

newGatewayServer - com.mobileapps.pcre.PCREGateway

void setName(String name)

          Set the client's name.

Parameters:

name - The new name for this client.

void setReportEngineServer(PCREServer newReportEngineServer)

          Sets the pcreserver object associated with this client.

Parameters:

newReportEngineServer - com.mobileapps.pcre.PCREServer

void setThreadConsole(PCREConsole console)

          Set the console for the current thread.

Parameters:

console - The new console to associate with this thread.

void Terminate()

          Short-hand for Terminate(PCRE_FAIL);

void Terminate(int code)

          Terminate the client application.

Parameters:

code - The termination code.

Index