Index

Object HARMONI.HarmoniServer

Method Index

o Connect()
Connect the client to the Harmoni Server.
o Disconnect()
Notify the Harmoni Server that the client is disconnecting.
o EndService(String)
Terminate the API service on the server.
o getAPI()
Return the api reference for the server.
o getArguments()
Return the Harmoni Server command-line arguments.
o getCommandArgs()
Return the server command-line arguments.
o getEngineStartMonitor()
 
o getExecutable()
Return the Harmoni Server executable.
o GetFolder()
Return the API server's current working folder.
o getHost()
Return the host-name of the Harmoni Server.
o getName()
Return the name of the Harmoni Server.
o getService()
Return the service-name of the Harmoni Server.
o GetVersion()
Return a string with the API server version.
o OpenEngine(HarmoniClient, boolean)
Acquire and optionally open a print-engine for this client.
o setExecutable(String)
Set the Harmoni Server executable to the given string.
o SetFolder(String)
Set the API srrver's working folder.
o setHost(String)
Set the host-name of the Harmoni Server.
o setName(String)
Set the name of the Harmoni Server.
o SetOption(String, String)
Set server option with the given value.
o StartService(String)
Start the API service on the server.

Method Detail

o Connect
void Connect()
          Connect the client to the Harmoni Server.
o Disconnect
void Disconnect()
          Notify the Harmoni Server that the client is disconnecting.
o EndService
void EndService(String apiName)
          Terminate the API service on the server.
Parameters:
apiName - The name of the API that should be terminated.
o getAPI
HarmoniAPIServer getAPI()
          Return the api reference for the server.
Returns:
The API associated with this server.
o getArguments
String getArguments()
          Return the Harmoni Server command-line arguments.
Returns:
The current arguments for this server.
o getCommandArgs
String getCommandArgs()
          Return the server command-line arguments.
Returns:
The command line arguments for this server.
o getEngineStartMonitor
HarmoniEngineStartMonitor getEngineStartMonitor()
o getExecutable
String getExecutable()
          Return the Harmoni Server executable.
Returns:
The executatable filename for this server.
o GetFolder
String GetFolder()
          Return the API server's current working folder.
Returns:
The current working folder for the server.
o getHost
String getHost()
          Return the host-name of the Harmoni Server.
Returns:
The host-name of this server.
o getName
String getName()
          Return the name of the Harmoni Server.
Returns:
The name of this server.
o getService
String getService()
          Return the service-name of the Harmoni Server.
Returns:
The service-name of this server.
o GetVersion
String GetVersion()
          Return a string with the API server version.
Returns:
The version string.
o OpenEngine
HarmoniEngine OpenEngine(HarmoniClient client,
                         boolean open)
          Acquire and optionally open a print-engine for this client.
Parameters:
client - The current client instance.
open - If true, open the print-engine on the server.
Returns:
A print-engine object.
o setExecutable
void setExecutable(String exeString)
          Set the Harmoni Server executable to the given string.
Parameters:
exeString - The path, and filname to the Harmoni Server.
o SetFolder
void SetFolder(String folder)
          Set the API srrver's working folder.
Parameters:
folder - The new working directory for the server.
o setHost
void setHost(String address)
          Set the host-name of the Harmoni Server.
Parameters:
address - The new host-name for this server.
o setName
void setName(String name)
          Set the name of the Harmoni Server.
Parameters:
name - The new name for this server.
o SetOption
void SetOption(String option,
               String value)
          Set server option with the given value.
Parameters:
option - The name of the option that is being modified.
value - The new value for this option.
o StartService
Object StartService(String apiName)
          Start the API service on the server.
Parameters:
apiName - The name of the API object that the server is providing. 
Index