com.esri.arcgis.catalog
Interface IGxObjectFilter

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpsLogFilter, GxFilterAnnotationFeatureClasses, GxFilterBasicTypes, GxFilterCadAnnotationClasses, GxFilterCadastralFabrics, GxFilterCadDrawingDatasets, GxFilterCadFeatureClasses, GxFilterContainers, GxFilterCoverageAnnotationClasses, GxFilterCoverageFeatureClasses, GxFilterCoverages, GxFilterDataElements, GxFilterDataGraphs, GxFilterDatasets, GxFilterDatasetsAndLayers, GxFilterdBASEFiles, GxFilterDefaultDatabaseWorkspaces, GxFilterDimensionFeatureClasses, GxFilterFeatureClasses, GxFilterFeatureDatasets, GxFilterFeatureDatasetsAndFeatureClasses, GxFilterFGDBFeatureClasses, GxFilterFGDBFeatureDatasets, GxFilterFGDBTables, GxFilterFileGeodatabases, GxFilterFiles, GxFilterFileToolboxes, GxFilterGeoDataServers, GxFilterGeoDataServersAndWorkspaces, GxFilterGeoDatasets, GxFilterGeometricNetworks, GxFilterGlobeCaches, GxFilterGlobes, GxFilterGlobeServers, GxFilterGPServers, GxFilterImageServerDataSource, GxFilterImageServers, GxFilterInfoTables, GxFilterLayers, GxFilterMapDatasetsAndLayers, GxFilterMaps, GxFilterMapServers, GxFilterMapServersTilingScheme, GxFilterMosaicDatasets, GxFilterMSDFiles, GxFilterNetworkDatasets, GxFilterPersonalGeodatabases, GxFilterPGDBFeatureClasses, GxFilterPGDBFeatureDatasets, GxFilterPGDBTables, GxFilterPointFeatureClasses, GxFilterPolygonFeatureClasses, GxFilterPolylineFeatureClasses, GxFilterRasterCatalogDatasets, GxFilterRasterDatasets, GxFilterRelationshipClasses, GxFilterRemoteMetadata, GxFilterRemoteMetadataContainer, GxFilterRoute, GxFilterRunningMapServers, GxFilterSceneDatasets, GxFilterSceneDatasetsAndLayers, GxFilterScenes, GxFilterSDCFeatureClasses, GxFilterSDCFeatureDatasets, GxFilterSDCNetworkDatasets, GxFilterSDCTables, GxFilterSDEFeatureClasses, GxFilterSDEFeatureDatasets, GxFilterSDETables, GxFilterSearchServers, GxFilterShapefiles, GxFilterSpatialReferences, GxFilterStreetMapFeatureClasses, GxFilterSurfaceDatasets, GxFilterTables, GxFilterTablesAndFeatureClasses, GxFilterTerrains, GxFilterTextFiles, GxFilterTINDatasets, GxFilterToolboxes, GxFilterTools, GxFilterTopologies, GxFilterVerticalCoordinateSystems, GxFilterWCSCoverage, GxFilterWMS, GxFilterWorkspaces, IGxObjectFilterProxy, RasterFormatBILFilter, RasterFormatBIPFilter, RasterFormatBMPFilter, RasterFormatBSQFilter, RasterFormatENVIFilter, RasterFormatFGDBFilter, RasterFormatGIFFilter, RasterFormatGridFilter, RasterFormatImgFilter, RasterFormatJP2Filter, RasterFormatJPGFilter, RasterFormatPGDBFilter, RasterFormatPNGFilter, RasterFormatSDEFilter, RasterFormatTifFilter

public interface IGxObjectFilter
extends Serializable

Provides access to members that defines a GxObject filter.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	canChooseObject(IGxObject object, int[] result) Indicates if the given object can be chosen.
boolean	canDisplayObject(IGxObject object) Indicates if the given object can be displayed.
boolean	canSaveObject(IGxObject location, String newObjectName, boolean[] objectAlreadyExists) Indicates if a new object named newObjectName could be saved in the specified location.
String	getDescription() A string that describes what this filter does.
String	getName() A user-friendly name identifying this filter.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

A user-friendly name identifying this filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

A string that describes what this filter does.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDisplayObject

boolean canDisplayObject(IGxObject object)
                         throws IOException,
                                AutomationException

Indicates if the given object can be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The canDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canChooseObject

boolean canChooseObject(IGxObject object,
                        int[] result)
                        throws IOException,
                               AutomationException

Indicates if the given object can be chosen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

result - A com.esri.arcgis.catalog.esriDoubleClickResult constant (in/out: use single element array)

Returns:

The canChoose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSaveObject

boolean canSaveObject(IGxObject location,
                      String newObjectName,
                      boolean[] objectAlreadyExists)
                      throws IOException,
                             AutomationException

Indicates if a new object named newObjectName could be saved in the specified location. If objectAlreadyExists is set to True, a confirmation dialog will appear asking if the existing object should be replaced.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

location - A reference to a com.esri.arcgis.catalog.IGxObject (in)

newObjectName - The newObjectName (in)

objectAlreadyExists - The objectAlreadyExists (in/out: use single element array)

Returns:

The canSave

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.