com.esri.arcgis.geodatabase
Interface IDEBrowseOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
DEBrowseOptions

public interface IDEBrowseOptions
extends Serializable

Provides access to the data element browsing options interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getExpandType()
          Data element expand type - none, immediate children or all descendants.
 boolean isRetrieveFullProperties()
          Indicates if full properties of a data element should be fetched (heavy-weight properties that involve opening the underlying dataset).
 boolean isRetrieveMetadata()
          Indicates if the data element's metadata should be fetched.
 void setExpandType(int expandType)
          Data element expand type - none, immediate children or all descendants.
 void setRetrieveFullProperties(boolean fullProp)
          Indicates if full properties of a data element should be fetched (heavy-weight properties that involve opening the underlying dataset).
 void setRetrieveMetadata(boolean fullProp)
          Indicates if the data element's metadata should be fetched.
 

Method Detail

getExpandType

int getExpandType()
                  throws IOException,
                         AutomationException
Data element expand type - none, immediate children or all descendants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriDEExpandType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpandType

void setExpandType(int expandType)
                   throws IOException,
                          AutomationException
Data element expand type - none, immediate children or all descendants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
expandType - A com.esri.arcgis.geodatabase.esriDEExpandType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRetrieveFullProperties

boolean isRetrieveFullProperties()
                                 throws IOException,
                                        AutomationException
Indicates if full properties of a data element should be fetched (heavy-weight properties that involve opening the underlying dataset).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fullProp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRetrieveFullProperties

void setRetrieveFullProperties(boolean fullProp)
                               throws IOException,
                                      AutomationException
Indicates if full properties of a data element should be fetched (heavy-weight properties that involve opening the underlying dataset).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fullProp - The fullProp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRetrieveMetadata

boolean isRetrieveMetadata()
                           throws IOException,
                                  AutomationException
Indicates if the data element's metadata should be fetched.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fullProp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRetrieveMetadata

void setRetrieveMetadata(boolean fullProp)
                         throws IOException,
                                AutomationException
Indicates if the data element's metadata should be fetched.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fullProp - The fullProp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.