Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.catalog
Interface IGxCatalogAdmin

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IGxCatalogAdminProxy
public interface IGxCatalogAdmin
extends java.io.Serializable

COM Interface 'IGxCatalogAdmin'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description: 'Provides access to members that manage the behavior of the GX catalog object.' 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
static java.lang.String IID
          Deprecated. Internal use only
static int IID9598fb2f_22ba_11d3_9f58_00c04f6bc69e
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 

Field Detail

IID9598fb2f_22ba_11d3_9f58_00c04f6bc69e

static final int IID9598fb2f_22ba_11d3_9f58_00c04f6bc69e
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

setCachedLocations

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

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

getCachedLocations

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

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

getRootObjectCount

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

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

getRootObject

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

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

isRootObjectEnabled

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

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

enableRootObject

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

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

refreshRootObjects

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

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

setHideExtensions

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

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

isHideExtensions

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

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

setReturnToLastLocation

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

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

isReturnToLastLocation

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

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

setPrescanFolders

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

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

isPrescanFolders

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

Returns:
The prescanFolders
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD