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

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() Commit to the CMS any changes that are made to the job server.
int	getCurrentJobs() Returns the current number of jobs processing.
IJobServerDestination[]	getDestinations(IInfoStore infostore) Returns the collection of destinations supported by Job Servers.
java.lang.String	getDLLName() Returns the DLL associated with the object type the Job Server processes.
int	getFailedCreated() Returns the total number of failed job creations.
int	getMaxJobs() Returns the maximum number of requests the Job Server can process at one time.
java.lang.String	getObjectTypeName() Returns the Object type name processed by the Job Server.
int	getProcType() Returns the process mode for every request.
java.lang.String	getTempDir() Returns the location of the Job Servers temporary files.
int	getTotalJobs() Returns the number of job requests received.
void	setMaxJobs(int n) Sets the maximum number of requests the Job Server can process at one time.
void	setTempDir(java.lang.String dir) Sets the location of the Job Servers temporary files.

Method Detail

getMaxJobs

public int getMaxJobs()
               throws SDKException

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

public void setMaxJobs(int n)
                throws SDKException

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

public java.lang.String getObjectTypeName()
                                   throws SDKException

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

public java.lang.String getDLLName()
                            throws SDKException

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

public int getCurrentJobs()
                   throws SDKException

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

public int getTotalJobs()
                 throws SDKException

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

public int getFailedCreated()
                     throws SDKException

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

public java.lang.String getTempDir()
                            throws SDKException

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

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

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

public int getProcType()
                throws SDKException

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

public IJobServerDestination[] getDestinations(IInfoStore infostore)
                                        throws SDKException

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

public void commit()
            throws SDKException

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

Throws:

SDKException - This is thrown if the process is unsuccessful.