com.esri.arcgis.catalog
Interface IGxCatalogAdmin

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGxCatalogAdminProxy

public interface IGxCatalogAdmin
extends Serializable

Provides access to members that manage the behavior of the GX catalog object.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 void enableRootObject(int index, boolean isEnabled)
          Enables or disables the specified root-level object within the catalog.
 IEnumBSTR getCachedLocations()
          The cached locations.
 IGxObject getRootObject(int index)
          The specified root-level object.
 int getRootObjectCount()
          The number of root-level objects in the catalog.
 boolean isHideExtensions()
          Indicates if file extensions are hidden.
 boolean isPrescanFolders()
          Indicates if ArcCatalog should prescan folders and display them with a special icon if they contain GIS data.
 boolean isReturnToLastLocation()
          Indicates if ArcCatalog should return to last location on startup.
 boolean isRootObjectEnabled(int index)
          Indicates if the specified root-level object is enabled within the catalog.
 void refreshRootObjects()
          Refreshes the catalog's root objects without refreshing disk connections.
 void setCachedLocations(IEnumBSTR locations)
          The cached locations.
 void setHideExtensions(boolean isHidden)
          Indicates if file extensions are hidden.
 void setPrescanFolders(boolean prescanFolders)
          Indicates if ArcCatalog should prescan folders and display them with a special icon if they contain GIS data.
 void setReturnToLastLocation(boolean isSet)
          Indicates if ArcCatalog should return to last location on startup.
 

Method Detail

setCachedLocations

void setCachedLocations(IEnumBSTR locations)
                        throws IOException,
                               AutomationException
The cached locations.

Product Availability

Available with ArcGIS Desktop.

Parameters:
locations - A reference to a com.esri.arcgis.system.IEnumBSTR (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCachedLocations

IEnumBSTR getCachedLocations()
                             throws IOException,
                                    AutomationException
The cached locations.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRootObjectCount

int getRootObjectCount()
                       throws IOException,
                              AutomationException
The number of root-level objects in the catalog.

Product Availability

Available with ArcGIS Desktop.

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

getRootObject

IGxObject getRootObject(int index)
                        throws IOException,
                               AutomationException
The specified root-level object.

Product Availability

Available with ArcGIS Desktop.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRootObjectEnabled

boolean isRootObjectEnabled(int index)
                            throws IOException,
                                   AutomationException
Indicates if the specified root-level object is enabled within the catalog.

Product Availability

Available with ArcGIS Desktop.

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

enableRootObject

void enableRootObject(int index,
                      boolean isEnabled)
                      throws IOException,
                             AutomationException
Enables or disables the specified root-level object within the catalog.

Product Availability

Available with ArcGIS Desktop.

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

refreshRootObjects

void refreshRootObjects()
                        throws IOException,
                               AutomationException
Refreshes the catalog's root objects without refreshing disk connections.

Product Availability

Available with ArcGIS Desktop.

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

setHideExtensions

void setHideExtensions(boolean isHidden)
                       throws IOException,
                              AutomationException
Indicates if file extensions are hidden.

Product Availability

Available with ArcGIS Desktop.

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

isHideExtensions

boolean isHideExtensions()
                         throws IOException,
                                AutomationException
Indicates if file extensions are hidden.

Product Availability

Available with ArcGIS Desktop.

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

setReturnToLastLocation

void setReturnToLastLocation(boolean isSet)
                             throws IOException,
                                    AutomationException
Indicates if ArcCatalog should return to last location on startup.

Product Availability

Available with ArcGIS Desktop.

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

isReturnToLastLocation

boolean isReturnToLastLocation()
                               throws IOException,
                                      AutomationException
Indicates if ArcCatalog should return to last location on startup.

Product Availability

Available with ArcGIS Desktop.

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

setPrescanFolders

void setPrescanFolders(boolean prescanFolders)
                       throws IOException,
                              AutomationException
Indicates if ArcCatalog should prescan folders and display them with a special icon if they contain GIS data.

Product Availability

Available with ArcGIS Desktop.

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

isPrescanFolders

boolean isPrescanFolders()
                         throws IOException,
                                AutomationException
Indicates if ArcCatalog should prescan folders and display them with a special icon if they contain GIS data.

Product Availability

Available with ArcGIS Desktop.

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