com.esri.arcgis.carto
Interface IImageServerDownloadResults

All Superinterfaces:

Serializable

All Known Implementing Classes:

ImageServerDownloadResults

public interface IImageServerDownloadResults
extends Serializable

Provides access to the Image Server Download Results Interface.

Remarks

ImageServerDownloadResults contains multiple ImageServerDownloadResult objects, and each one of them contain a downloadable file and its size in bytes.

The number of items that can be downloaded is defined in the image service configuration. One item might be corresponding to multiple files. For example a raster of a pan-sharpened image service consists of a single band raster dataset and a multiple band raster dataset, where each dataset might consist of multiple files such as an image file, a world file, and a pyramid file. The returned downloadable files can be URLs (e.g. http://, or ftp://) that are directly downloadable from a remote server. They can also be files that are known only to the image service. In this case, GetFile() should be used to prepare the file for download and get a public URL.

Downloading formats of folder structure, for example ESRI GRID, is not supported.

Product Availability

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

Method Summary

void	add(IImageServerDownloadResult pDownloadResult) Adds a download result.
int	getCount() The download result count.
IImageServerDownloadResult	getElement(int index) The download result at the specified position.
void	insert(int index, IImageServerDownloadResult pDownloadResult) Adds a download result at the specified position.
void	remove(int index) Removes the download result at the specified position.
void	removeAll() Removes all download results.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The download result count.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IImageServerDownloadResult getElement(int index)
                                      throws IOException,
                                             AutomationException

The download result at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the download result at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all download results.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IImageServerDownloadResult pDownloadResult)
         throws IOException,
                AutomationException

Adds a download result.

Product Availability

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

Parameters:

pDownloadResult - A reference to a com.esri.arcgis.carto.IImageServerDownloadResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IImageServerDownloadResult pDownloadResult)
            throws IOException,
                   AutomationException

Adds a download result at the specified position.

Product Availability

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

Parameters:

index - The index (in)

pDownloadResult - A reference to a com.esri.arcgis.carto.IImageServerDownloadResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.