com.esri.arcgis.carto
Interface IImageServiceInfo2

All Superinterfaces:

IImageServiceInfo, Serializable

All Known Subinterfaces:

IImageServiceInfo3

All Known Implementing Classes:

ImageServiceInfo

public interface IImageServiceInfo2
extends IImageServiceInfo, Serializable

Provides access to the properties of an image service.

Description

This interface is new at ArcGIS 10.

Remarks

IImageServiceInfo provides access to more properties of an image service: allowed fileds, allowed compressions, allowed mosaic methods, default compression, default compression quality, default mosaic method, default resampling method, etc.

Product Availability

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

Method Summary

String	getAllowedCompressions() The list of allowed client controllable transmition compressions.
String	getAllowedFields() The list of visible field names.
String	getAllowedItemMetadata() The level of item metadata details.
String	getAllowedMosaicMethods() The list of allowed client controllable mosaic methods.
String	getDefaultCompression() The default transmission compression, None, LZ77, JPEG.
int	getDefaultCompressionQuality() The default transmission compression quality (1-100).
int	getDefaultMosaicMethod() The default mosaic method.
int	getDefaultResamplingMethod() The default resampling method.
String	getEndTimeFieldName() The end time field name.
int	getMaxDownloadImageCount() The maximum number of images allowed for download.
int	getMaxMosaicImageCount() The maximum number of images allowed for mosaic.
int	getMaxRecordCount() The maximum number of records returned for query results.
String	getStartTimeFieldName() The start time field name.
ITimeExtent	getTimeExtent() The time extent.
ITimeReference	getTimeReference() The time reference.
String	getTimeValueFormat() The time value format.
boolean	isSupportBSQ() Indicates if output can be generated in BSQ pixel interleave format.
boolean	isSupportsTime() Indicates if time is supported.
void	setAllowedCompressions(String pAllowedCompressions) The list of allowed client controllable transmition compressions.
void	setAllowedFields(String pAllowedFields) The list of visible field names.
void	setAllowedItemMetadata(String pLOD) The level of item metadata details.
void	setAllowedMosaicMethods(String pAllowedMethods) The list of allowed client controllable mosaic methods.
void	setDefaultCompression(String pCompression) The default transmission compression, None, LZ77, JPEG.
void	setDefaultCompressionQuality(int pQuality) The default transmission compression quality (1-100).
void	setDefaultMosaicMethod(int pMosaicMethod) The default mosaic method.
void	setDefaultResamplingMethod(int pResamplingMethod) The default resampling method.
void	setEndTimeFieldName(String pFieldName) The end time field name.
void	setMaxDownloadImageCount(int pCount) The maximum number of images allowed for download.
void	setMaxMosaicImageCount(int pCount) The maximum number of images allowed for mosaic.
void	setMaxNCols(int rhs1) The maximum number of colums this service supports.
void	setMaxNRows(int rhs1) The maximum number of rows this service supports.
void	setMaxRecordCount(int pCount) The maximum number of records returned for query results.
void	setStartTimeFieldName(String pFieldName) The start time field name.
void	setSupportBSQ(boolean pBSQ) Indicates if output can be generated in BSQ pixel interleave format.
void	setSupportsTime(boolean supports) Indicates if time is supported.
void	setTimeExtentByRef(ITimeExtent ppTimeExtent) The time extent.
void	setTimeReferenceByRef(ITimeReference ppTimeReference) The time reference.
void	setTimeValueFormat(String pTimeFormat) The time value format.

Methods inherited from interface com.esri.arcgis.carto.IImageServiceInfo

getBandCount, getCopyrightText, getDefaultServiceProperties, getDescription, getExtent, getMaximumPixelSize, getMaxNCols, getMaxNRows, getMinimumPixelSize, getName, getNoData, getPixelSize, getPixelType, getServiceDataType, getServiceSourceType, getSpatialReference, getStatistics, setCopyrightText, setDefaultServiceProperties, setServiceDataType, setServiceSourceType

Method Detail

getAllowedFields

String getAllowedFields()
                        throws IOException,
                               AutomationException

The list of visible field names.

Product Availability

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

Returns:

The pAllowedFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedFields

void setAllowedFields(String pAllowedFields)
                      throws IOException,
                             AutomationException

The list of visible field names.

Product Availability

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

Parameters:

pAllowedFields - The pAllowedFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedCompressions

String getAllowedCompressions()
                              throws IOException,
                                     AutomationException

The list of allowed client controllable transmition compressions.

Product Availability

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

Returns:

The pAllowedCompressions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedCompressions

void setAllowedCompressions(String pAllowedCompressions)
                            throws IOException,
                                   AutomationException

The list of allowed client controllable transmition compressions.

Product Availability

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

Parameters:

pAllowedCompressions - The pAllowedCompressions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedMosaicMethods

String getAllowedMosaicMethods()
                               throws IOException,
                                      AutomationException

The list of allowed client controllable mosaic methods.

Product Availability

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

Returns:

The pAllowedMethods

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedMosaicMethods

void setAllowedMosaicMethods(String pAllowedMethods)
                             throws IOException,
                                    AutomationException

The list of allowed client controllable mosaic methods.

Product Availability

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

Parameters:

pAllowedMethods - The pAllowedMethods (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllowedItemMetadata

String getAllowedItemMetadata()
                              throws IOException,
                                     AutomationException

The level of item metadata details.

Product Availability

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

Returns:

The pLOD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowedItemMetadata

void setAllowedItemMetadata(String pLOD)
                            throws IOException,
                                   AutomationException

The level of item metadata details.

Product Availability

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

Parameters:

pLOD - The pLOD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

int getMaxRecordCount()
                      throws IOException,
                             AutomationException

The maximum number of records returned for query results.

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.

setMaxRecordCount

void setMaxRecordCount(int pCount)
                       throws IOException,
                              AutomationException

The maximum number of records returned for query results.

Product Availability

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

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxDownloadImageCount

int getMaxDownloadImageCount()
                             throws IOException,
                                    AutomationException

The maximum number of images allowed for download.

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.

setMaxDownloadImageCount

void setMaxDownloadImageCount(int pCount)
                              throws IOException,
                                     AutomationException

The maximum number of images allowed for download.

Product Availability

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

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxMosaicImageCount

int getMaxMosaicImageCount()
                           throws IOException,
                                  AutomationException

The maximum number of images allowed for mosaic.

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.

setMaxMosaicImageCount

void setMaxMosaicImageCount(int pCount)
                            throws IOException,
                                   AutomationException

The maximum number of images allowed for mosaic.

Product Availability

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

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxNCols

void setMaxNCols(int rhs1)
                 throws IOException,
                        AutomationException

The maximum number of colums this service supports.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxNRows

void setMaxNRows(int rhs1)
                 throws IOException,
                        AutomationException

The maximum number of rows this service supports.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCompression

String getDefaultCompression()
                             throws IOException,
                                    AutomationException

The default transmission compression, None, LZ77, JPEG.

Product Availability

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

Returns:

The pCompression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCompression

void setDefaultCompression(String pCompression)
                           throws IOException,
                                  AutomationException

The default transmission compression, None, LZ77, JPEG.

Product Availability

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

Parameters:

pCompression - The pCompression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCompressionQuality

int getDefaultCompressionQuality()
                                 throws IOException,
                                        AutomationException

The default transmission compression quality (1-100).

Product Availability

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

Returns:

The pQuality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCompressionQuality

void setDefaultCompressionQuality(int pQuality)
                                  throws IOException,
                                         AutomationException

The default transmission compression quality (1-100).

Product Availability

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

Parameters:

pQuality - The pQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultResamplingMethod

int getDefaultResamplingMethod()
                               throws IOException,
                                      AutomationException

The default resampling method.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultResamplingMethod

void setDefaultResamplingMethod(int pResamplingMethod)
                                throws IOException,
                                       AutomationException

The default resampling method.

Product Availability

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

Parameters:

pResamplingMethod - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultMosaicMethod

int getDefaultMosaicMethod()
                           throws IOException,
                                  AutomationException

The default mosaic method.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultMosaicMethod

void setDefaultMosaicMethod(int pMosaicMethod)
                            throws IOException,
                                   AutomationException

The default mosaic method.

Product Availability

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

Parameters:

pMosaicMethod - A com.esri.arcgis.datasourcesraster.esriMosaicMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportBSQ

boolean isSupportBSQ()
                     throws IOException,
                            AutomationException

Indicates if output can be generated in BSQ pixel interleave format.

Product Availability

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

Returns:

The pBSQ

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportBSQ

void setSupportBSQ(boolean pBSQ)
                   throws IOException,
                          AutomationException

Indicates if output can be generated in BSQ pixel interleave format.

Product Availability

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

Parameters:

pBSQ - The pBSQ (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

boolean isSupportsTime()
                       throws IOException,
                              AutomationException

Indicates if time is supported.

Product Availability

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

Returns:

The supports

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsTime

void setSupportsTime(boolean supports)
                     throws IOException,
                            AutomationException

Indicates if time is supported.

Product Availability

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

Parameters:

supports - The supports (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

String getStartTimeFieldName()
                             throws IOException,
                                    AutomationException

The start time field name.

Product Availability

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

Returns:

The pFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

void setStartTimeFieldName(String pFieldName)
                           throws IOException,
                                  AutomationException

The start time field name.

Product Availability

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

Parameters:

pFieldName - The pFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

String getEndTimeFieldName()
                           throws IOException,
                                  AutomationException

The end time field name.

Product Availability

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

Returns:

The pFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

void setEndTimeFieldName(String pFieldName)
                         throws IOException,
                                AutomationException

The end time field name.

Product Availability

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

Parameters:

pFieldName - The pFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

String getTimeValueFormat()
                          throws IOException,
                                 AutomationException

The time value format.

Product Availability

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

Returns:

The pTimeFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

void setTimeValueFormat(String pTimeFormat)
                        throws IOException,
                               AutomationException

The time value format.

Product Availability

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

Parameters:

pTimeFormat - The pTimeFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

The time reference.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference ppTimeReference)
                           throws IOException,
                                  AutomationException

The time reference.

Product Availability

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

Parameters:

ppTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeExtent

ITimeExtent getTimeExtent()
                          throws IOException,
                                 AutomationException

The time extent.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeExtentByRef

void setTimeExtentByRef(ITimeExtent ppTimeExtent)
                        throws IOException,
                               AutomationException

The time extent.

Product Availability

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

Parameters:

ppTimeExtent - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.