com.esri.arcgis.carto
Class MapCacheExporterJob

java.lang.Object
  com.esri.arcgis.carto.MapCacheExporterJob

All Implemented Interfaces:

IMapCacheExporterJob, IServerThreadedJob, IThreadedJob, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class MapCacheExporterJob
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapCacheExporterJob, IServerThreadedJob, IPersist, IPersistStream, IClone, Externalizable

A threaded processor.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

MapCacheExporterJob()
Constructs a MapCacheExporterJob using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
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
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	execute(ITrackCancel pTrackCancel) Executes the job.
IEnvelope	getCacheExtent() Cache Extent.
void	getClassID(GUID[] pClassID) getClassID
IGeometry	getClipGeometry() ClipGeometry
static String	getClsid() getClsid.
IStream	getContextStream() Returns a server context object serialized into a stream.
String	getDataframe() Dataframe name.
int	getExportMode() Set the export mode.
String	getHost() Server machine name.
int	getLevel() Cancel the current job.
IThreadedJobResult	getResult() The result of this job.
IServerContext	getServerContext() The server context associated with the job.
String	getService() Service name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ICacheStorageInfo	getSourceCacheStorageInfo() CacheStorageInfo.
ITileCacheInfo	getSourceTileCacheInfo() SourceTileCacheInfo.
ITileImageInfo	getSourceTileImageInfo() SourceTileImageInfo.
ICacheStorageInfo	getTargetCacheStorageInfo() TargetCacheStorageInfo.
ITileCacheInfo	getTargetTileCacheInfo() TargetTileCacheInfo.
ITileImageInfo	getTargetTileImageInfo() TargetTileImageInfo.
void	getTileRangeX(int[] pTileXMin, int[] pTileXMax) Cancel the current job.
void	getTileRangeY(int[] pTileYMin, int[] pTileYMax) Cancel the current job.
ITrackCancel	getTrackCancel() Returns a cancel tracker object created on the server context.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isOverwrite() Cancel the current job.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	releaseContext() Release the associated server context.
void	save(IStream pstm, int fClearDirty) save
void	setCacheExtentByRef(IEnvelope ppCacheExtent) Cache Extent.
void	setClipGeometryByRef(IGeometry ppGeometry) ClipGeometry
void	setDataframe(String pDataframe) Dataframe name.
void	setExportMode(int pMode) Set the export mode.
void	setHost(String pHost) Server machine name.
void	setLevel(int pLevel) Cancel the current job.
void	setOverwrite(boolean pOverwrite) Cancel the current job.
void	setService(String pService) Service name.
void	setSourceCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo) CacheStorageInfo.
void	setSourceLevelCacheDirectory(String sourceCacheDir) Cancel the current job.
void	setSourceTileCacheInfoByRef(ITileCacheInfo ppSourceTileCacheInfo) SourceTileCacheInfo.
void	setSourceTileImageInfoByRef(ITileImageInfo ppSourceTileImageInfo) SourceTileImageInfo.
void	setTargetCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo) TargetCacheStorageInfo.
void	setTargetLevelCacheDirectory(String targetCacheDir) Cancel the current job.
void	setTargetTileCacheInfoByRef(ITileCacheInfo ppTargetTileCacheInfo) TargetTileCacheInfo.
void	setTargetTileImageInfoByRef(ITileImageInfo ppTargetTileImageInfo) TargetTileImageInfo.
void	setThreadNumber(int threadID) Sets the thread number on the job.
void	setTileRangeX(int tileXMin, int tileXMax) Cancel the current job.
void	setTileRangeY(int tileYMin, int tileYMax) Cancel the current job.
void	writeExternal(ObjectOutput out)

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

MapCacheExporterJob

public MapCacheExporterJob()
                    throws IOException,
                           UnknownHostException

Constructs a MapCacheExporterJob using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapCacheExporterJob

public MapCacheExporterJob(Object obj)
                    throws IOException

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

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

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

setTileRangeX

public void setTileRangeX(int tileXMin,
                          int tileXMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTileRangeX in interface IMapCacheExporterJob

Parameters:

tileXMin - The tileXMin (in)

tileXMax - The tileXMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRangeY

public void setTileRangeY(int tileYMin,
                          int tileYMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTileRangeY in interface IMapCacheExporterJob

Parameters:

tileYMin - The tileYMin (in)

tileYMax - The tileYMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRangeX

public void getTileRangeX(int[] pTileXMin,
                          int[] pTileXMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getTileRangeX in interface IMapCacheExporterJob

Parameters:

pTileXMin - The pTileXMin (out: use single element array)

pTileXMax - The pTileXMax (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRangeY

public void getTileRangeY(int[] pTileYMin,
                          int[] pTileYMax)
                   throws IOException,
                          AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getTileRangeY in interface IMapCacheExporterJob

Parameters:

pTileYMin - The pTileYMin (out: use single element array)

pTileYMax - The pTileYMax (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevel

public void setLevel(int pLevel)
              throws IOException,
                     AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setLevel in interface IMapCacheExporterJob

Parameters:

pLevel - The pLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevel

public int getLevel()
             throws IOException,
                    AutomationException

Cancel the current job.

Product Availability

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

Specified by:

getLevel in interface IMapCacheExporterJob

Returns:

The pLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverwrite

public void setOverwrite(boolean pOverwrite)
                  throws IOException,
                         AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setOverwrite in interface IMapCacheExporterJob

Parameters:

pOverwrite - The pOverwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverwrite

public boolean isOverwrite()
                    throws IOException,
                           AutomationException

Cancel the current job.

Product Availability

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

Specified by:

isOverwrite in interface IMapCacheExporterJob

Returns:

The pOverwrite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceLevelCacheDirectory

public void setSourceLevelCacheDirectory(String sourceCacheDir)
                                  throws IOException,
                                         AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setSourceLevelCacheDirectory in interface IMapCacheExporterJob

Parameters:

sourceCacheDir - The sourceCacheDir (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetLevelCacheDirectory

public void setTargetLevelCacheDirectory(String targetCacheDir)
                                  throws IOException,
                                         AutomationException

Cancel the current job.

Product Availability

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

Specified by:

setTargetLevelCacheDirectory in interface IMapCacheExporterJob

Parameters:

targetCacheDir - The targetCacheDir (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExportMode

public int getExportMode()
                  throws IOException,
                         AutomationException

Set the export mode.

Product Availability

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

Specified by:

getExportMode in interface IMapCacheExporterJob

Returns:

A com.esri.arcgis.carto.esriCacheExporterMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExportMode

public void setExportMode(int pMode)
                   throws IOException,
                          AutomationException

Set the export mode.

Product Availability

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

Specified by:

setExportMode in interface IMapCacheExporterJob

Parameters:

pMode - A com.esri.arcgis.carto.esriCacheExporterMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataframe

public String getDataframe()
                    throws IOException,
                           AutomationException

Dataframe name.

Product Availability

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

Specified by:

getDataframe in interface IMapCacheExporterJob

Returns:

The pDataframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataframe

public void setDataframe(String pDataframe)
                  throws IOException,
                         AutomationException

Dataframe name.

Product Availability

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

Specified by:

setDataframe in interface IMapCacheExporterJob

Parameters:

pDataframe - The pDataframe (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheExtent

public IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException

Cache Extent.

Product Availability

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

Specified by:

getCacheExtent in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheExtentByRef

public void setCacheExtentByRef(IEnvelope ppCacheExtent)
                         throws IOException,
                                AutomationException

Cache Extent.

Product Availability

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

Specified by:

setCacheExtentByRef in interface IMapCacheExporterJob

Parameters:

ppCacheExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTileCacheInfo

public ITileCacheInfo getSourceTileCacheInfo()
                                      throws IOException,
                                             AutomationException

SourceTileCacheInfo.

Product Availability

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

Specified by:

getSourceTileCacheInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ITileCacheInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTileCacheInfoByRef

public void setSourceTileCacheInfoByRef(ITileCacheInfo ppSourceTileCacheInfo)
                                 throws IOException,
                                        AutomationException

SourceTileCacheInfo.

Product Availability

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

Specified by:

setSourceTileCacheInfoByRef in interface IMapCacheExporterJob

Parameters:

ppSourceTileCacheInfo - A reference to a com.esri.arcgis.carto.ITileCacheInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetTileCacheInfo

public ITileCacheInfo getTargetTileCacheInfo()
                                      throws IOException,
                                             AutomationException

TargetTileCacheInfo.

Product Availability

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

Specified by:

getTargetTileCacheInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ITileCacheInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetTileCacheInfoByRef

public void setTargetTileCacheInfoByRef(ITileCacheInfo ppTargetTileCacheInfo)
                                 throws IOException,
                                        AutomationException

TargetTileCacheInfo.

Product Availability

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

Specified by:

setTargetTileCacheInfoByRef in interface IMapCacheExporterJob

Parameters:

ppTargetTileCacheInfo - A reference to a com.esri.arcgis.carto.ITileCacheInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTileImageInfo

public ITileImageInfo getSourceTileImageInfo()
                                      throws IOException,
                                             AutomationException

SourceTileImageInfo.

Product Availability

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

Specified by:

getSourceTileImageInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ITileImageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTileImageInfoByRef

public void setSourceTileImageInfoByRef(ITileImageInfo ppSourceTileImageInfo)
                                 throws IOException,
                                        AutomationException

SourceTileImageInfo.

Product Availability

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

Specified by:

setSourceTileImageInfoByRef in interface IMapCacheExporterJob

Parameters:

ppSourceTileImageInfo - A reference to a com.esri.arcgis.carto.ITileImageInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetTileImageInfo

public ITileImageInfo getTargetTileImageInfo()
                                      throws IOException,
                                             AutomationException

TargetTileImageInfo.

Product Availability

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

Specified by:

getTargetTileImageInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ITileImageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetTileImageInfoByRef

public void setTargetTileImageInfoByRef(ITileImageInfo ppTargetTileImageInfo)
                                 throws IOException,
                                        AutomationException

TargetTileImageInfo.

Product Availability

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

Specified by:

setTargetTileImageInfoByRef in interface IMapCacheExporterJob

Parameters:

ppTargetTileImageInfo - A reference to a com.esri.arcgis.carto.ITileImageInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceCacheStorageInfo

public ICacheStorageInfo getSourceCacheStorageInfo()
                                            throws IOException,
                                                   AutomationException

CacheStorageInfo.

Product Availability

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

Specified by:

getSourceCacheStorageInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ICacheStorageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceCacheStorageInfoByRef

public void setSourceCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
                                    throws IOException,
                                           AutomationException

CacheStorageInfo.

Product Availability

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

Specified by:

setSourceCacheStorageInfoByRef in interface IMapCacheExporterJob

Parameters:

ppCacheStorageInfo - A reference to a com.esri.arcgis.carto.ICacheStorageInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetCacheStorageInfo

public ICacheStorageInfo getTargetCacheStorageInfo()
                                            throws IOException,
                                                   AutomationException

TargetCacheStorageInfo.

Product Availability

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

Specified by:

getTargetCacheStorageInfo in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.carto.ICacheStorageInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetCacheStorageInfoByRef

public void setTargetCacheStorageInfoByRef(ICacheStorageInfo ppCacheStorageInfo)
                                    throws IOException,
                                           AutomationException

TargetCacheStorageInfo.

Product Availability

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

Specified by:

setTargetCacheStorageInfoByRef in interface IMapCacheExporterJob

Parameters:

ppCacheStorageInfo - A reference to a com.esri.arcgis.carto.ICacheStorageInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipGeometry

public IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException

ClipGeometry

Product Availability

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

Specified by:

getClipGeometry in interface IMapCacheExporterJob

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipGeometryByRef

public void setClipGeometryByRef(IGeometry ppGeometry)
                          throws IOException,
                                 AutomationException

ClipGeometry

Product Availability

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

Specified by:

setClipGeometryByRef in interface IMapCacheExporterJob

Parameters:

ppGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException