com.crystaldecisions.sdk.plugin.admin.jobserveradmin
Interface IJobServerAdmin

Deprecated. As of version 12.0. Servers are managed using com.crystaldecisions.sdk.plugin.desktop.server.IServer. See the BusinessObjects Enterprise SDK Java Developer Guide for information on how to programmatically perform server administration tasks using the new Server Intelligence framework.

public interface IJobServerAdmin

The IJobServerAdmin interface provides metrics on the types of jobs allowed, type of processing, as well as numerical statistics dealing with total, current, and failed jobs. You can also set the maximum number of jobs allowed and retrieve the JobServerDestinations collection.

Method Summary

void	commit() Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.
int	getCurrentJobs() Deprecated. As of version 12.0.
IJobServerDestination[]	getDestinations(IInfoStore infostore) Deprecated. As of version 12.0, replaced by com.crystaldecisions.sdk.plugin.desktop.server.IServer.getServerDestinations().
java.lang.String	getDLLName() Deprecated. As of version 12.0.
int	getFailedCreated() Deprecated. As of version 12.0.
int	getMaxJobs() Deprecated. As of version 12.0.
java.lang.String	getObjectTypeName() Deprecated. As of version 12.0.
int	getProcType() Deprecated. As of version 12.0.
java.lang.String	getTempDir() Deprecated. As of version 12.0.
int	getTotalJobs() Deprecated. As of version 12.0.
void	setMaxJobs(int n) Deprecated. As of version 12.0.
void	setTempDir(java.lang.String dir) Deprecated. As of version 12.0.

Method Detail

getMaxJobs

int getMaxJobs()
               throws SDKException

Deprecated. As of version 12.0.

Returns the maximum number of requests the Job Server can process at one time.

Returns:

An int specifying the maximum number of requests the Job Server can process at one time.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMaxJobs

void setMaxJobs(int n)
                throws SDKException

Deprecated. As of version 12.0.

Sets the maximum number of requests the Job Server can process at one time.

Parameters:

n - An int specifying the maximum number of requests the Job Server can process at one time.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getObjectTypeName

java.lang.String getObjectTypeName()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns the Object type name processed by the Job Server. Note, the present build of this product is only able to process Report objects.

Returns:

A String containing the Object type name processed by the Job Server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDLLName

java.lang.String getDLLName()
                            throws SDKException

Deprecated. As of version 12.0.

Returns the DLL associated with the object type the Job Server processes.

Returns:

A String containing the DLL associated with the object type the Job Server processes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCurrentJobs

int getCurrentJobs()
                   throws SDKException

Deprecated. As of version 12.0.

Returns the current number of jobs processing.

Returns:

An int specifying the current number of jobs processing.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTotalJobs

int getTotalJobs()
                 throws SDKException

Deprecated. As of version 12.0.

Returns the number of job requests received.

Returns:

An int specifying the number of job requests received.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFailedCreated

int getFailedCreated()
                     throws SDKException

Deprecated. As of version 12.0.

Returns the total number of failed job creations.

Returns:

An int specifying the total number of failed job creations.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTempDir

java.lang.String getTempDir()
                            throws SDKException

Deprecated. As of version 12.0.

Returns the location of the Job Servers temporary files.

Returns:

A String containing the location of the Job Server temporary files.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setTempDir

void setTempDir(java.lang.String dir)
                throws SDKException

Deprecated. As of version 12.0.

Sets the location of the Job Servers temporary files.

Parameters:

dir - A String containing the location of the Job Server temporary files

Throws:

SDKException - This is thrown if the process is unsuccessful.

getProcType

int getProcType()
                throws SDKException

Deprecated. As of version 12.0.

Returns the process mode for every request.

Returns:

An int specifying the process mode for every request.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDestinations

IJobServerDestination[] getDestinations(IInfoStore infostore)
                                        throws SDKException

Deprecated. As of version 12.0, replaced by com.crystaldecisions.sdk.plugin.desktop.server.IServer.getServerDestinations().

Returns the collection of destinations supported by Job Servers.

Parameters:

infostore - An IInfoStore object from which the destinations will be returned.

Returns:

An array of IJobServerDestination objects containing the destination supported by Job Servers.

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.

Commit to the CMS any changes that are made to the job server.

Throws:

SDKException - This is thrown if the process is unsuccessful.