com.esri.arcgis.datasourcesraster
Class MosaicDatasetJob

java.lang.Object
  com.esri.arcgis.datasourcesraster.MosaicDatasetJob

All Implemented Interfaces:

IMosaicDatasetJobInfo, IServerThreadedJob, IThreadedJob, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MosaicDatasetJob
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IThreadedJob, IServerThreadedJob, IMosaicDatasetJobInfo

A mosaic dataset job.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MosaicDatasetJob()
Constructs a MosaicDatasetJob using ArcGIS Engine.

MosaicDatasetJob(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicDatasetJob theMosaicDatasetJob = (MosaicDatasetJob) obj;

Method Summary

void	cancel() Cancel the current job.
void	createContext() Create a server context associated with the job.
boolean	equals(Object o) Compare this object with another
void	execute(ITrackCancel pTrackCancel) Executes the job.
static String	getClsid() getClsid.
IStream	getContextStream() Returns a server context object serialized into a stream.
String	getHost() Server machine name.
IMosaicDatasetName	getMosaicDatasetName() The name object associated with the mosaic dataset on which the operation is performed.
String	getOperationName() The name of the mosaic dataset operation associated with this job.
IMosaicDatasetOperationParameters	getOperationParameters() The parameters object that control the mosaic dataset operation performed as part of the job.
IThreadedJobResult	getResult() The result of this job.
IServerContext	getServerContext() The server context associated with the job.
String	getService() Service name.
ITrackCancel	getTrackCancel() Returns a cancel tracker object created on the server context.
int	hashCode() the hashcode for this object
void	releaseContext() Release the associated server context.
void	setHost(String pHost) Server machine name.
void	setMosaicDatasetNameByRef(IMosaicDatasetName ppDatasetName) The name object associated with the mosaic dataset on which the operation is performed.
void	setOperationName(String pOperationName) The name of the mosaic dataset operation associated with this job.
void	setOperationParametersByRef(IMosaicDatasetOperationParameters ppParameters) The parameters object that control the mosaic dataset operation performed as part of the job.
void	setService(String pService) Service name.
void	setThreadNumber(int threadID) Sets the thread number on the job.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MosaicDatasetJob

public MosaicDatasetJob()
                 throws IOException,
                        UnknownHostException

Constructs a MosaicDatasetJob using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MosaicDatasetJob

public MosaicDatasetJob(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicDatasetJob theMosaicDatasetJob = (MosaicDatasetJob) obj;

Construct a MosaicDatasetJob using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MosaicDatasetJob.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setThreadNumber

public void setThreadNumber(int threadID)
                     throws IOException,
                            AutomationException

Sets the thread number on the job.

Product Availability

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

Specified by:

setThreadNumber in interface IThreadedJob

Parameters:

threadID - The threadID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ITrackCancel pTrackCancel)
             throws IOException,
                    AutomationException

Executes the job.

Product Availability

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

Specified by:

execute in interface IThreadedJob

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResult

public IThreadedJobResult getResult()
                             throws IOException,
                                    AutomationException

The result of this job.

Product Availability

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

Specified by:

getResult in interface IThreadedJob

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IThreadedJobResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException

Cancel the current job.

Product Availability

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

Specified by:

cancel in interface IThreadedJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHost

public String getHost()
               throws IOException,
                      AutomationException

Server machine name.

Product Availability

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

Specified by:

getHost in interface IServerThreadedJob

Returns:

The pHost

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHost

public void setHost(String pHost)
             throws IOException,
                    AutomationException

Server machine name.

Product Availability

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

Specified by:

setHost in interface IServerThreadedJob

Parameters:

pHost - The pHost (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getService

public String getService()
                  throws IOException,
                         AutomationException

Service name.

Product Availability

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

Specified by:

getService in interface IServerThreadedJob

Returns:

The pService

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setService

public void setService(String pService)
                throws IOException,
                       AutomationException

Service name.

Product Availability

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

Specified by:

setService in interface IServerThreadedJob

Parameters:

pService - The pService (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createContext

public void createContext()
                   throws IOException,
                          AutomationException

Create a server context associated with the job.

Product Availability

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

Specified by:

createContext in interface IServerThreadedJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseContext

public void releaseContext()
                    throws IOException,
                           AutomationException

Release the associated server context.

Product Availability

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

Specified by:

releaseContext in interface IServerThreadedJob

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerContext

public IServerContext getServerContext()
                                throws IOException,
                                       AutomationException

The server context associated with the job.

Product Availability

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

Specified by:

getServerContext in interface IServerThreadedJob

Returns:

A reference to a com.esri.arcgis.server.IServerContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws IOException,
                                   AutomationException

Returns a cancel tracker object created on the server context. Fails is no server context is available.

Product Availability

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

Specified by:

getTrackCancel in interface IServerThreadedJob

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextStream

public IStream getContextStream()
                         throws IOException,
                                AutomationException

Returns a server context object serialized into a stream.

Product Availability

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

Specified by:

getContextStream in interface IServerThreadedJob

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicDatasetNameByRef

public void setMosaicDatasetNameByRef(IMosaicDatasetName ppDatasetName)
                               throws IOException,
                                      AutomationException

The name object associated with the mosaic dataset on which the operation is performed.

Product Availability

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

Specified by:

setMosaicDatasetNameByRef in interface IMosaicDatasetJobInfo

Parameters:

ppDatasetName - A reference to a com.esri.arcgis.geodatabase.IMosaicDatasetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicDatasetName

public IMosaicDatasetName getMosaicDatasetName()
                                        throws IOException,
                                               AutomationException

The name object associated with the mosaic dataset on which the operation is performed.

Product Availability

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

Specified by:

getMosaicDatasetName in interface IMosaicDatasetJobInfo

Returns:

A reference to a com.esri.arcgis.geodatabase.IMosaicDatasetName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOperationParametersByRef

public void setOperationParametersByRef(IMosaicDatasetOperationParameters ppParameters)
                                 throws IOException,
                                        AutomationException

The parameters object that control the mosaic dataset operation performed as part of the job.

Product Availability

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

Specified by:

setOperationParametersByRef in interface IMosaicDatasetJobInfo

Parameters:

ppParameters - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationParameters

public IMosaicDatasetOperationParameters getOperationParameters()
                                                         throws IOException,
                                                                AutomationException

The parameters object that control the mosaic dataset operation performed as part of the job.

Product Availability

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

Specified by:

getOperationParameters in interface IMosaicDatasetJobInfo

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOperationName

public void setOperationName(String pOperationName)
                      throws IOException,
                             AutomationException

The name of the mosaic dataset operation associated with this job.

Product Availability

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

Specified by:

setOperationName in interface IMosaicDatasetJobInfo

Parameters:

pOperationName - The pOperationName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationName

public String getOperationName()
                        throws IOException,
                               AutomationException

The name of the mosaic dataset operation associated with this job.

Product Availability

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

Specified by:

getOperationName in interface IMosaicDatasetJobInfo

Returns:

The pOperationName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.