com.esri.arcgis.catalog
Class IGxCatalogAdminProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalog.IGxCatalogAdminProxy

All Implemented Interfaces:

IGxCatalogAdmin, Externalizable, Serializable

public class IGxCatalogAdminProxy
extends com.esri.arcgis.interop.Dispatch
implements IGxCatalogAdmin, Serializable

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

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGxCatalogAdminProxy()
	IGxCatalogAdminProxy(Object obj)
protected	IGxCatalogAdminProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGxCatalogAdminProxy

public IGxCatalogAdminProxy()

IGxCatalogAdminProxy

public IGxCatalogAdminProxy(Object obj)
                     throws IOException

Throws:

IOException

IGxCatalogAdminProxy

protected IGxCatalogAdminProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setCachedLocations

public void setCachedLocations(IEnumBSTR locations)
                        throws IOException,
                               AutomationException

The cached locations.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCachedLocations in interface IGxCatalogAdmin

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

public IEnumBSTR getCachedLocations()
                             throws IOException,
                                    AutomationException

The cached locations.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getCachedLocations in interface IGxCatalogAdmin

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

public int getRootObjectCount()
                       throws IOException,
                              AutomationException

The number of root-level objects in the catalog.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getRootObjectCount in interface IGxCatalogAdmin

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRootObject

public IGxObject getRootObject(int index)
                        throws IOException,
                               AutomationException

The specified root-level object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getRootObject in interface IGxCatalogAdmin

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

public 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.

Specified by:

isRootObjectEnabled in interface IGxCatalogAdmin

Parameters:

index - The index (in)

Returns:

The isEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableRootObject

public 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.

Specified by:

enableRootObject in interface IGxCatalogAdmin

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

public void refreshRootObjects()
                        throws IOException,
                               AutomationException

Refreshes the catalog's root objects without refreshing disk connections.

Product Availability

Available with ArcGIS Desktop.

Specified by:

refreshRootObjects in interface IGxCatalogAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideExtensions

public void setHideExtensions(boolean isHidden)
                       throws IOException,
                              AutomationException

Indicates if file extensions are hidden.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setHideExtensions in interface IGxCatalogAdmin

Parameters:

isHidden - The isHidden (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideExtensions

public boolean isHideExtensions()
                         throws IOException,
                                AutomationException

Indicates if file extensions are hidden.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isHideExtensions in interface IGxCatalogAdmin

Returns:

The isHidden

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnToLastLocation

public void setReturnToLastLocation(boolean isSet)
                             throws IOException,
                                    AutomationException

Indicates if ArcCatalog should return to last location on startup.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setReturnToLastLocation in interface IGxCatalogAdmin

Parameters:

isSet - The isSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnToLastLocation

public boolean isReturnToLastLocation()
                               throws IOException,
                                      AutomationException

Indicates if ArcCatalog should return to last location on startup.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isReturnToLastLocation in interface IGxCatalogAdmin

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrescanFolders

public 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.

Specified by:

setPrescanFolders in interface IGxCatalogAdmin

Parameters:

prescanFolders - The prescanFolders (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrescanFolders

public 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.

Specified by:

isPrescanFolders in interface IGxCatalogAdmin

Returns:

The prescanFolders

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.