com.esri.arcgis.geoprocessing
Interface IMapCacheTileManagerJob

All Superinterfaces:
Serializable

public interface IMapCacheTileManagerJob
extends Serializable

Executes in parallel and performs the job.

Product Availability

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


Method Summary
 void enableLocalCaching(boolean localCaching)
          Enable local caching.
 IEnvelope getCacheExtent()
          Cache Extent.
 IGeometry getClipGeometry()
          ClipGeometry
 String getDataframe()
          Dataframe name.
 String getLayerName()
          Layer name.
 int getLevel()
          Cancel the current job.
 int getTileManagerMode()
          Cancel the current job.
 void getTileRangeX(int[] pTileXMin, int[] pTileXMax)
          Cancel the current job.
 void getTileRangeY(int[] pTileYMin, int[] pTileYMax)
          Cancel the current job.
 void setCacheExtentByRef(IEnvelope ppCacheExtent)
          Cache Extent.
 void setClipGeometryByRef(IGeometry ppGeometry)
          ClipGeometry
 void setDataframe(String pDataframe)
          Dataframe name.
 void setLayerName(String pLayerName)
          Layer name.
 void setLevel(int pLevel)
          Cancel the current job.
 void setTileManagerMode(int pMode)
          Cancel the current job.
 void setTileRangeX(int tileXMin, int tileXMax)
          Cancel the current job.
 void setTileRangeY(int tileYMin, int tileYMax)
          Cancel the current job.
 

Method Detail

setTileRangeX

void setTileRangeX(int tileXMin,
                   int tileXMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

void setTileRangeY(int tileYMin,
                   int tileYMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

void getTileRangeX(int[] pTileXMin,
                   int[] pTileXMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

void getTileRangeY(int[] pTileYMin,
                   int[] pTileYMax)
                   throws IOException,
                          AutomationException
Cancel the current job.

Product Availability

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

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

void setLevel(int pLevel)
              throws IOException,
                     AutomationException
Cancel the current job.

Product Availability

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

Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLevel

int getLevel()
             throws IOException,
                    AutomationException
Cancel the current job.

Product Availability

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

Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileManagerMode

int getTileManagerMode()
                       throws IOException,
                              AutomationException
Cancel the current job.

Product Availability

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

Returns:
A com.esri.arcgis.carto.esriMapCacheUpdateMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileManagerMode

void setTileManagerMode(int pMode)
                        throws IOException,
                               AutomationException
Cancel the current job.

Product Availability

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

Parameters:
pMode - A com.esri.arcgis.carto.esriMapCacheUpdateMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataframe

String getDataframe()
                    throws IOException,
                           AutomationException
Dataframe name.

Product Availability

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

Returns:
The pDataframe
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataframe

void setDataframe(String pDataframe)
                  throws IOException,
                         AutomationException
Dataframe name.

Product Availability

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

Parameters:
pDataframe - The pDataframe (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerName

String getLayerName()
                    throws IOException,
                           AutomationException
Layer name.

Product Availability

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

Returns:
The pLayerName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerName

void setLayerName(String pLayerName)
                  throws IOException,
                         AutomationException
Layer name.

Product Availability

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

Parameters:
pLayerName - The pLayerName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enableLocalCaching

void enableLocalCaching(boolean localCaching)
                        throws IOException,
                               AutomationException
Enable local caching.

Product Availability

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

Parameters:
localCaching - The localCaching (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheExtent

IEnvelope getCacheExtent()
                         throws IOException,
                                AutomationException
Cache Extent.

Product Availability

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

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

void setCacheExtentByRef(IEnvelope ppCacheExtent)
                         throws IOException,
                                AutomationException
Cache Extent.

Product Availability

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

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.

getClipGeometry

IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException
ClipGeometry

Product Availability

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

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

void setClipGeometryByRef(IGeometry ppGeometry)
                          throws IOException,
                                 AutomationException
ClipGeometry

Product Availability

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

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.