com.esri.arcgis.datasourcesraster
Interface IRasterTypeDataSourceHandlerParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterTypeDataSourceHandlerParameters

public interface IRasterTypeDataSourceHandlerParameters
extends Serializable

Provides access to members that control parameters to raster type data source handler.

Product Availability

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

Method Summary

Object	getDataSource() The data source to be supplied to handler operations.
IArray	getRasterTypes() The collection of raster types on which the handler operates.
ITrackCancel	getTrackCancel() The cancel tracker associated with handler operations.
boolean	isAllowAncillaryDatasets() Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.
boolean	isStopAtFirstFind() Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.
boolean	isTryQuickCheckOnly() Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.
void	setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets) Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.
void	setDataSource(Object pvtDataSource) The data source to be supplied to handler operations.
void	setRasterTypesByRef(IArray ppRasterTypes) The collection of raster types on which the handler operates.
void	setStopAtFirstFind(boolean pbStopAtFirstFind) Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The cancel tracker associated with handler operations.
void	setTryQuickCheckOnly(boolean pbTryQuickCheckOnly) Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Method Detail

setDataSource

void setDataSource(Object pvtDataSource)
                   throws IOException,
                          AutomationException

The data source to be supplied to handler operations.

Product Availability

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

Parameters:

pvtDataSource - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

Object getDataSource()
                     throws IOException,
                            AutomationException

The data source to be supplied to handler operations.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypesByRef

void setRasterTypesByRef(IArray ppRasterTypes)
                         throws IOException,
                                AutomationException

The collection of raster types on which the handler operates.

Product Availability

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

Parameters:

ppRasterTypes - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterTypes

IArray getRasterTypes()
                      throws IOException,
                             AutomationException

The collection of raster types on which the handler operates.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws IOException,
                                AutomationException

The cancel tracker associated with handler operations.

Product Availability

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

Parameters:

ppTrackCancel - 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.

getTrackCancel

ITrackCancel getTrackCancel()
                            throws IOException,
                                   AutomationException

The cancel tracker associated with handler operations.

Product Availability

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

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.

setTryQuickCheckOnly

void setTryQuickCheckOnly(boolean pbTryQuickCheckOnly)
                          throws IOException,
                                 AutomationException

Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Product Availability

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

Parameters:

pbTryQuickCheckOnly - The pbTryQuickCheckOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTryQuickCheckOnly

boolean isTryQuickCheckOnly()
                            throws IOException,
                                   AutomationException

Indicates whether handler operations perform only cursory checks (via IRasterBuilder.CanBuild) on data sources to identify candidate raster types and templates.

Product Availability

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

Returns:

The pbTryQuickCheckOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopAtFirstFind

void setStopAtFirstFind(boolean pbStopAtFirstFind)
                        throws IOException,
                               AutomationException

Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.

Product Availability

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

Parameters:

pbStopAtFirstFind - The pbStopAtFirstFind (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopAtFirstFind

boolean isStopAtFirstFind()
                          throws IOException,
                                 AutomationException

Indicates whether handler operations stops searching for candidate raster types or templates once the first candidate is found.

Product Availability

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

Returns:

The pbStopAtFirstFind

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowAncillaryDatasets

void setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets)
                               throws IOException,
                                      AutomationException

Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.

Product Availability

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

Parameters:

pbAllowAncillaryDatasets - The pbAllowAncillaryDatasets (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowAncillaryDatasets

boolean isAllowAncillaryDatasets()
                                 throws IOException,
                                        AutomationException

Indicates whether ancillary dataset generated by complex raster type item templates are to be allowed by handler operations.

Product Availability

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

Returns:

The pbAllowAncillaryDatasets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.