com.esri.arcgis.system

Interface IJobCatalog

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IJobCatalogProxy

public interface IJobCatalog
extends java.io.Serializable

COM Interface 'IJobCatalog'. Generated 9/24/2024 11:01:27 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to methods that control a catalog of jobs.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID5c395aac_ebbc_4ffd_bb1e_c99858e168e0
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
IJob	createJob() Creates a job and adds it to the catalog.
IJobFilter	createJobFilter() Creates a filter used for searching jobs.
IJob	getJob(java.lang.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(java.lang.String root, java.lang.String jobProcessorName, java.lang.String jobProcessorType) Initializes the job catalog.
void	removeJob(java.lang.String jobID) Removes job with given id from the catalog.
void	setJobRegistry(IJobRegistry rhs1) Job Registry.

Field Detail

IID5c395aac_ebbc_4ffd_bb1e_c99858e168e0

static final int IID5c395aac_ebbc_4ffd_bb1e_c99858e168e0

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String root,
          java.lang.String jobProcessorName,
          java.lang.String jobProcessorType)
   throws java.io.IOException,
          AutomationException

Initializes the job catalog.

Parameters:

root - The root (in)

jobProcessorName - The jobProcessorName (in)

jobProcessorType - The jobProcessorType (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobRegistry

void setJobRegistry(IJobRegistry rhs1)
             throws java.io.IOException,
                    AutomationException

Job Registry.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createJob

IJob createJob()
        throws java.io.IOException,
               AutomationException

Creates a job and adds it to the catalog.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createJobFilter

IJobFilter createJobFilter()
                    throws java.io.IOException,
                           AutomationException

Creates a filter used for searching jobs.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJob

IJob getJob(java.lang.String jobID,
            boolean bLock)
     throws java.io.IOException,
            AutomationException

Retrieves job with given id from the catalog.

Parameters:

jobID - The jobID (in)

bLock - The bLock (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeJob

void removeJob(java.lang.String jobID)
        throws java.io.IOException,
               AutomationException

Removes job with given id from the catalog.

Parameters:

jobID - The jobID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobIDs

IEnumBSTR getJobIDs(IJobFilter pFilter)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.