com.esri.arcgis.carto
Interface ICacheDescriptionInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
CacheDescriptionInfo, ICacheDescriptionInfoProxy

public interface ICacheDescriptionInfo
extends Serializable

Provides access to members that provide the cache description info.

Remarks

CacheDescriptionInfo includes information on a cached map service. This includes its cache type, its tiling scheme (TileCacheInfo), image information (TileImageInfo) and control information (TileControlInfo ). The cache description also includes an array of layer cache infos that can be used to determine if a specific layer has a cache in the case of map services that have a multi layer cache.

Product Availability

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


Method Summary
 ICacheControlInfo getCacheControlInfo()
          CacheControlInfo object.
 int getCacheType()
          Cache type.
 ILayerCacheInfos getLayerCacheInfos()
          LayerCacheInfos object.
 ITileCacheInfo getTileCacheInfo()
          TileCacheInfo object.
 ITileImageInfo getTileImageInfo()
          TileImageInfo object.
 void setCacheControlInfoByRef(ICacheControlInfo ppCacheControlInfo)
          CacheControlInfo object.
 void setCacheType(int pServiceType)
          Cache type.
 void setLayerCacheInfosByRef(ILayerCacheInfos ppLayerCacheInfos)
          LayerCacheInfos object.
 void setTileCacheInfoByRef(ITileCacheInfo ppTileCacheInfo)
          TileCacheInfo object.
 void setTileImageInfoByRef(ITileImageInfo ppTileIamgeInfo)
          TileImageInfo object.
 

Method Detail

getTileCacheInfo

ITileCacheInfo getTileCacheInfo()
                                throws IOException,
                                       AutomationException
TileCacheInfo object.

Product Availability

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

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.

setTileCacheInfoByRef

void setTileCacheInfoByRef(ITileCacheInfo ppTileCacheInfo)
                           throws IOException,
                                  AutomationException
TileCacheInfo object.

Product Availability

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

Parameters:
ppTileCacheInfo - 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.

getTileImageInfo

ITileImageInfo getTileImageInfo()
                                throws IOException,
                                       AutomationException
TileImageInfo object.

Product Availability

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

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.

setTileImageInfoByRef

void setTileImageInfoByRef(ITileImageInfo ppTileIamgeInfo)
                           throws IOException,
                                  AutomationException
TileImageInfo object.

Product Availability

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

Parameters:
ppTileIamgeInfo - 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.

getCacheControlInfo

ICacheControlInfo getCacheControlInfo()
                                      throws IOException,
                                             AutomationException
CacheControlInfo object.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.carto.ICacheControlInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheControlInfoByRef

void setCacheControlInfoByRef(ICacheControlInfo ppCacheControlInfo)
                              throws IOException,
                                     AutomationException
CacheControlInfo object.

Product Availability

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

Parameters:
ppCacheControlInfo - A reference to a com.esri.arcgis.carto.ICacheControlInfo (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerCacheInfos

ILayerCacheInfos getLayerCacheInfos()
                                    throws IOException,
                                           AutomationException
LayerCacheInfos object.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.carto.ILayerCacheInfos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerCacheInfosByRef

void setLayerCacheInfosByRef(ILayerCacheInfos ppLayerCacheInfos)
                             throws IOException,
                                    AutomationException
LayerCacheInfos object.

Product Availability

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

Parameters:
ppLayerCacheInfos - A reference to a com.esri.arcgis.carto.ILayerCacheInfos (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheType

int getCacheType()
                 throws IOException,
                        AutomationException
Cache type.

Product Availability

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

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

setCacheType

void setCacheType(int pServiceType)
                  throws IOException,
                         AutomationException
Cache type.

Product Availability

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

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