com.esri.arcgis.datasourcesraster

Interface IRasterTypeDataSourceHandlerParameters

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IRasterTypeDataSourceHandlerParameters2, IRasterTypeDataSourceHandlerParameters3

All Known Implementing Classes:

IRasterTypeDataSourceHandlerParameters2Proxy, IRasterTypeDataSourceHandlerParameters3Proxy, IRasterTypeDataSourceHandlerParametersProxy, RasterTypeDataSourceHandlerParameters

public interface IRasterTypeDataSourceHandlerParameters
extends java.io.Serializable

COM Interface 'IRasterTypeDataSourceHandlerParameters'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control parameters to raster type data source handler.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID5f88e212_6325_4c5a_bb8f_eeae77a56f87
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.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(java.lang.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.

Field Detail

IID5f88e212_6325_4c5a_bb8f_eeae77a56f87

static final int IID5f88e212_6325_4c5a_bb8f_eeae77a56f87

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setDataSource

void setDataSource(java.lang.Object pvtDataSource)
            throws java.io.IOException,
                   AutomationException

The data source to be supplied to handler operations.

Parameters:

pvtDataSource - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

java.lang.Object getDataSource()
                        throws java.io.IOException,
                               AutomationException

The data source to be supplied to handler operations.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypesByRef

void setRasterTypesByRef(IArray ppRasterTypes)
                  throws java.io.IOException,
                         AutomationException

The collection of raster types on which the handler operates.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterTypes

IArray getRasterTypes()
               throws java.io.IOException,
                      AutomationException

The collection of raster types on which the handler operates.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                  throws java.io.IOException,
                         AutomationException

The cancel tracker associated with handler operations.

Parameters:

ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

ITrackCancel getTrackCancel()
                     throws java.io.IOException,
                            AutomationException

The cancel tracker associated with handler operations.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTryQuickCheckOnly

void setTryQuickCheckOnly(boolean pbTryQuickCheckOnly)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

pbTryQuickCheckOnly - The pbTryQuickCheckOnly (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTryQuickCheckOnly

boolean isTryQuickCheckOnly()
                     throws java.io.IOException,
                            AutomationException

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

Returns:

The pbTryQuickCheckOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopAtFirstFind

void setStopAtFirstFind(boolean pbStopAtFirstFind)
                 throws java.io.IOException,
                        AutomationException

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

Parameters:

pbStopAtFirstFind - The pbStopAtFirstFind (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStopAtFirstFind

boolean isStopAtFirstFind()
                   throws java.io.IOException,
                          AutomationException

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

Returns:

The pbStopAtFirstFind

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowAncillaryDatasets

void setAllowAncillaryDatasets(boolean pbAllowAncillaryDatasets)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

pbAllowAncillaryDatasets - The pbAllowAncillaryDatasets (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowAncillaryDatasets

boolean isAllowAncillaryDatasets()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The pbAllowAncillaryDatasets

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.