Index

Object HARMONI.HarmoniClient

CRYSTAL7

Crystal 7 Server Type

CRYSTAL9

Crystal 9 Server Type

folder

folder variable

HARMONI_FAIL

Failure return code.

HARMONI_NAME

The default Harmoni name

HARMONI_OK

Successful return code.

priority

priority variable

PRIORITY_HIGH

HIGH PRIORITY variable

PRIORITY_LOW

LOW PRIORITY variable

PRIORITY_MEDIUM

MEDIUM PRIORITY variable

verbose

verbose variable

WORD

Word Server Type

Connect()

Connect client to selected Harmoni services.

Connect(boolean)

Connect client to selected Harmoni services.

Connected(String)

Is the Client connected to named service.

Disconnect()

Disconnect client from all Harmoni services.

GetAPI(String)

Get an API object from the registry.

getArchiveFileReturnOption()

Getter method for zipFlag member.

getClientName()

Getter method for clientName member

getConfigServer()

Returns the config server object associated with this client.

getDisableServerTimeout()

Getter method for disableServerTimeout flag.

getFolder()

Getter method for folder member

getGateway()

Returns the gateway server object associated with this client.

getHost()

Return the Harmoni client's host IP-address.

getLog()

Return the Harmoni client's log

getName()

Return the client's name.

getORB()

Return the client orb.

getPOA()

 

GetPrinterInfo(String, StringBuffer, HarmoniDEVMODE)

This method returns the printer Info given the Printer Name

GetPrinterNames()

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

getPriority()

Getter method for priority member.

getServer()

Returns the Harmoniserver object associated with this client.

getServerType()

 

GetService(String)

Get a service from the client's registry.

getSharedORB()

Get the shared ORB instance.

getVerbose()

Getter method for verbose member

OpenCrystalEngine()

Acquire a print-engine for this client.

OpenWordEngine()

Acquire a print-engine for this client.

PutAPI(String, Object)

Put an API object into the registry.

PutService(HarmoniService)

Enter a Harmoni service in the client's registry.

Quit()

Short-hand for Quit(HarmoniClient.Harmoni_OK).

Quit(int)

Disconnect client from all Harmoni services.

RemoveAPI(String)

Remove an API object from the registry.

RemoveService(String)

Remove a service from the client's registry.

ResetReportServer(HarmoniReportServerInfo)

 

SelectReportServer(String)

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

setArchiveFileReturnOption(boolean)

Setter method for zipFlag member.

setClientName(String)

Setter method for clientName member

setConfigServer(HarmoniConfigServer)

Sets the config server object associated with this client.

setDisableServerTimeout(boolean)

Setter method for disableServerTimeout flag.

setFolder(String)

Setter method for folder member

setGatewayServer(HarmoniGateway)

Sets the gateway server object associated with this client.

setLog(LogService)

 

setName(String)

Set the client's name.

setPriority(int)

Setter method for priority member.

setReportEngineServer(HarmoniServer)

Sets the Harmoniserver object associated with this client.

setServerType(String)

 

setSharedORB(ORB)

Set the shared ORB instance.

setVerbose(boolean)

Setter method for verbose member

Terminate()

Short-hand for Terminate(Harmoni_FAIL);

Terminate(int)

Terminate the client application.

int HARMONI_OK

          Successful return code.

int HARMONI_FAIL

          Failure return code.

String HARMONI_NAME

          The default Harmoni name

int PRIORITY_HIGH

          HIGH PRIORITY variable

int PRIORITY_MEDIUM

          MEDIUM PRIORITY variable

int PRIORITY_LOW

          LOW PRIORITY variable

String CRYSTAL7

          Crystal 7 Server Type

String CRYSTAL9

          Crystal 9 Server Type

String WORD

          Word Server Type

int priority

          priority variable

boolean verbose

          verbose variable

String folder

          folder variable

void Connect()

          Connect client to selected Harmoni services. Clients should override.

void Connect(boolean useLoadBalancer)

          Connect client to selected Harmoni 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 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 Disconnect()

          Disconnect client from all Harmoni services. Clients may override.

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.

HarmoniConfigServer getConfigServer()

          Returns the config server object associated with this client.

Returns:

com.dynalivery.Harmoni.HarmoniConfigServer

HarmoniGateway getGateway()

          Returns the gateway server object associated with this client.

Returns:

com.dynalivery.Harmoni.HarmoniGateway

LogService getLog()

          Return the Harmoni client's log

void setLog(LogService logger)

String getServerType()

void setServerType(String typ)

String getHost()

          Return the Harmoni 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.

POA getPOA()

String[] GetPrinterInfo(String printerName,
                        StringBuffer driverName,
                        HarmoniDEVMODE 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

HarmoniMode, - Holds the HarmoniDEVMODE 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

HarmoniServer getServer()

          Returns the Harmoniserver object associated with this client.

Returns:

com.dynalivery.harmoni.HarmoniServer

HarmoniService 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.

WordEngine OpenWordEngine()

          Acquire a print-engine for this client.

Returns:

The new HarmoniEngine object.

PCREEngine OpenCrystalEngine()

          Acquire a print-engine for this client.

Returns:

The new HarmoniEngine object.

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(HarmoniService service)

          Enter a Harmoni 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(HarmoniClient.Harmoni_OK).

void Quit(int code)

          Disconnect client from all Harmoni 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(HarmoniReportServerInfo rsinfo)

void SelectReportServer(String method)

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

void setConfigServer(HarmoniConfigServer newConfigServer)

          Sets the config server object associated with this client.

Parameters:

newConfigServer - com.dynalivery.harmoni.HarmoniConfigServer

void setGatewayServer(HarmoniGateway newGatewayServer)

          Sets the gateway server object associated with this client.

Parameters:

newGatewayServer - com.dynalivery.harmoni.HarmoniGateway

void setName(String name)

          Set the client's name.

Parameters:

name - The new name for this client.

void setReportEngineServer(HarmoniServer newReportEngineServer)

          Sets the Harmoniserver object associated with this client.

Parameters:

newReportEngineServer - com.dynalivery.harmoni.HarmoniServer

void Terminate()

          Short-hand for Terminate(Harmoni_FAIL);

void Terminate(int code)

          Terminate the client application.

Parameters:

code - The termination code.

void setPriority(int clientPriority)

          Setter method for priority member.

Parameters:

clientPriority - static integer variable

int getPriority()

          Getter method for priority member.

Returns:

priority member

void setArchiveFileReturnOption(boolean zipOption)

          Setter method for zipFlag member.

Parameters:

zipOption - boolean

boolean getArchiveFileReturnOption()

          Getter method for zipFlag member.

Returns:

zipFlag member

void setDisableServerTimeout(boolean timeoutFlag)

          Setter method for disableServerTimeout flag.

Parameters:

disableServerTimeout - boolean

boolean getDisableServerTimeout()

          Getter method for disableServerTimeout flag.

Returns:

disableServerTimeout member

ORB getSharedORB()

          Get the shared ORB instance.

Returns:

shrOrb

void setSharedORB(ORB theSharedORB)

          Set the shared ORB instance.

Parameters:

org.omg.CORBA.ORB -

boolean getVerbose()

          Getter method for verbose member

Returns:

verbose

void setVerbose(boolean value)

          Setter method for verbose member

Parameters:

verbose -

String getClientName()

          Getter method for clientName member

Returns:

clientName

void setClientName(String value)

          Setter method for clientName member

Parameters:

clientName -

String getFolder()

          Getter method for folder member

Returns:

folder

void setFolder(String value)

          Setter method for folder member

Parameters:

folder -

Index