com.esri.arcgis.system
Interface IJobCatalog

All Superinterfaces:

Serializable

public interface IJobCatalog
extends Serializable

Provides access to methods that control a catalog of jobs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IJob	createJob() Creates a job and adds it to the catalog.
IJobFilter	createJobFilter() Creates a filter used for searching jobs.
IJob	getJob(String jobID, boolean bLock) Retrieves job with given id from the catalog.
IEnumBSTR	getJobIDs(IJobFilter pFilter) Returns ids of all jobs in the catalog that match specified filter.
void	init(String root, String jobProcessorName, String jobProcessorType) Initializes the job catalog.
void	removeJob(String jobID) Removes job with given id from the catalog.
void	setJobRegistry(IJobRegistry rhs1) Job Registry.

Method Detail

init

void init(String root,
          String jobProcessorName,
          String jobProcessorType)
          throws IOException,
                 AutomationException

Initializes the job catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

root - The root (in)

jobProcessorName - The jobProcessorName (in)

jobProcessorType - The jobProcessorType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobRegistry

void setJobRegistry(IJobRegistry rhs1)
                    throws IOException,
                           AutomationException

Job Registry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IJobRegistry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createJob

IJob createJob()
               throws IOException,
                      AutomationException

Creates a job and adds it to the catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.IJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createJobFilter

IJobFilter createJobFilter()
                           throws IOException,
                                  AutomationException

Creates a filter used for searching jobs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.IJobFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJob

IJob getJob(String jobID,
            boolean bLock)
            throws IOException,
                   AutomationException

Retrieves job with given id from the catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

jobID - The jobID (in)

bLock - The bLock (in)

Returns:

A reference to a com.esri.arcgis.system.IJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeJob

void removeJob(String jobID)
               throws IOException,
                      AutomationException

Removes job with given id from the catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDs

IEnumBSTR getJobIDs(IJobFilter pFilter)
                    throws IOException,
                           AutomationException

Returns ids of all jobs in the catalog that match specified filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pFilter - A reference to a com.esri.arcgis.system.IJobFilter (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.