com.esri.arcgis.catalog
Class GxGDSGeodatabase

java.lang.Object
  com.esri.arcgis.catalog.GxGDSGeodatabase

All Implemented Interfaces:

IGxCachedObjects, IGxDatabase, IGxDatabase2, IGxDataElement, IGxDataElementHelper, IGxGeodatabase, IGxObject, IGxObjectContainer, IGxObjectInternalName, IGxObjectWizard, IGxPasteTarget, IGxRemoteConnection, IMetadata, IMetadataEdit, INativeTypeInfo, IWorkspaceEvents, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class GxGDSGeodatabase
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectContainer, IGxDatabase, IGxDatabase2, IGxObjectWizard, IMetadata, IMetadataEdit, IGxObjectInternalName, INativeTypeInfo, IGxPasteTarget, IGxCachedObjects, IWorkspaceEvents, IGxRemoteConnection, IGxDataElement, IGxDataElementHelper, IGxGeodatabase

GxObject that represents an ArcGIS Geodatabase connection.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

GxGDSGeodatabase()
Constructs a GxGDSGeodatabase using ArcGIS Engine.

GxGDSGeodatabase(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxGDSGeodatabase theGxGDSGeodatabase = (GxGDSGeodatabase) obj;

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
void	backup(String backupName, String backupFileName, String description, boolean[] isSimpleRecoveryModel) Backs up a Geodatabase from a Data server.
boolean	canPaste(IEnumName names, boolean[] moveOperation) Indicates if the specified names may be pasted into this object.
void	connect() Connectsto the underlying database.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	detachGeodatabase() Detach a Geodatabase from a Data server.
void	disconnect() Disconnects or releases the connection to the underlying database.
boolean	equals(Object o) Compare this object with another
String	getBaseName() The base name of the object (i.e.
String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static String	getClsid() getClsid.
IDataElement	getDataElement(IDEBrowseOptions browseOptions) Get the GxObject's data element.
Object	getDataServerManager() The Data Server Manager object.
String	getFullName() The full name of the object.
void	getGeodatabaseName(String[] name) The Geodatabase name.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
IPropertySet	getMetadata() The PropertySet containing metadata.
String	getName() The short name of the object.
INativeType	getNativeType() The native type.
IGxObject	getParent() The parent of the object.
void	getProperties(String[] owner, Object[] creationDate, int[] size, String[] fileLocation, Object[] lastBackup) Backup information.
IWorkspace	getWorkspace() The associated workspace.
IWorkspaceName	getWorkspaceName() The workspace name.
int	hashCode() the hashcode for this object
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isCanEditMetadata() Indicates if metadata can be edited.
boolean	isConnected() Indicates if the database is connected.
boolean	isEnterpriseGeodatabase() Indicates if the database is an enterprise geodatabase.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isRemoteDatabase() Indicates if the database is remote.
boolean	isValid() Indicates if the object is still valid.
void	loadCachedObjects() Loads any objects that should be cached for efficiency.
void	onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent) This event is fired when a dataset is created.
void	onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent) This event is fired when a dataset is deleted.
void	onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent) This event is fired when a dataset is renamed.
boolean	paste(IEnumName names, boolean[] moveOperation) Pastes the specified names into this object.
void	refresh() Updates the object and any children of the object.
void	releaseCachedObjects() Releases any objects that have been cached for efficiency.
void	retrieveDEBaseProperties(IDataElement[] dataElement) Retrieve the GxObject's light-weight properties.
void	retrieveDEFullProperties(IDataElement[] dataElement) Retrieve the GxObject's heavy-weight properties.
void	setInternalObjectNameByRef(IName internalObjectName) The Name for the internal object that this GxObject represents.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The workspace name.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.
void	upgrade() Upgrades Geodatabase.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GxGDSGeodatabase

public GxGDSGeodatabase()
                 throws IOException,
                        UnknownHostException

Constructs a GxGDSGeodatabase using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxGDSGeodatabase

public GxGDSGeodatabase(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxGDSGeodatabase theGxGDSGeodatabase = (GxGDSGeodatabase) obj;

Construct a GxGDSGeodatabase using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GxGDSGeodatabase.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The short name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException

The full name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFullName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException

The base name of the object (i.e. no extension).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBaseName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCategory in interface IGxObject

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws IOException,
                           AutomationException

The parent of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getParent in interface IGxObject

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.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxObject

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getInternalObjectName in interface IGxObject

Specified by:

getInternalObjectName in interface IGxObjectInternalName

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the object is still valid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isValid in interface IGxObject

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

attach in interface IGxObject

Parameters:

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

pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Instructs the object to detach itself from its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

detach in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Updates the object and any children of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws IOException,
                             AutomationException

Indicates if the object has any children.

Remarks

Note: This property always return True even when it has no children. This was done to improve the overall ArcCatalog browsing performance.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws IOException,
                                 AutomationException

An enumeration of the child objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChildren in interface IGxObjectContainer

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws IOException,
                          AutomationException

Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (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.

deleteChild

public void deleteChild(IGxObject child)
                 throws IOException,
                        AutomationException

Deletes the specified child object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException

The workspace name.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setWorkspaceNameByRef in interface IGxDatabase

Specified by:

setWorkspaceNameByRef in interface IGxDatabase2

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

The workspace name.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getWorkspaceName in interface IGxDatabase

Specified by:

getWorkspaceName in interface IGxDatabase2

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException

The associated workspace.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getWorkspace in interface IGxDatabase

Specified by:

getWorkspace in interface IGxDatabase2

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoteDatabase

public boolean isRemoteDatabase()
                         throws IOException,
                                AutomationException

Indicates if the database is remote.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isRemoteDatabase in interface IGxDatabase

Specified by:

isRemoteDatabase in interface IGxDatabase2

Returns:

The isRemoteDatabase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConnected

public boolean isConnected()
                    throws IOException,
                           AutomationException

Indicates if the database is connected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isConnected in interface IGxDatabase

Specified by:

isConnected in interface IGxDatabase2

Returns:

The isConnected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects or releases the connection to the underlying database.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

disconnect in interface IGxDatabase

Specified by:

disconnect in interface IGxDatabase2

Specified by:

disconnect in interface IGxRemoteConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnterpriseGeodatabase

public boolean isEnterpriseGeodatabase()
                                throws IOException,
                                       AutomationException

Indicates if the database is an enterprise geodatabase.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isEnterpriseGeodatabase in interface IGxDatabase2

Returns:

The isEnterpriseGeodatabase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect()
             throws IOException,
                    AutomationException

Connectsto the underlying database.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

connect in interface IGxDatabase2

Specified by:

connect in interface IGxRemoteConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException

The PropertySet containing metadata.

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMetadata in interface IMetadata

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException

The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action	Metadata status	Esri/Sync element	Interval parameter
esriMSAAccessed	Doesn't matter	Must not be FALSE	Must be less than actual interval
esriMSAAlways	Doesn't matter	Doesn't matter	Doesn't matter
esriMSACreated	Must not exist	Must not be FALSE	Must be less than actual interval
esriMSANotCreated	Must exist	Must not be FALSE	Must be less than actual interval
esriMSAOverwrite	Doesn't matter	Doesn't matter	Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws IOException,
                                 AutomationException

Indicates if metadata can be edited.

Remarks

This property is available to those objects that support metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The pCanEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInternalObjectNameByRef

public void setInternalObjectNameByRef(IName internalObjectName)
                                throws IOException,
                                       AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setInternalObjectNameByRef in interface IGxObjectInternalName

Parameters:

internalObjectName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws IOException,
                                 AutomationException

The native type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

A reference to a com.esri.arcgis.geodatabase.INativeType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws IOException,
                        AutomationException

Indicates if the specified names may be pasted into this object. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canPaste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

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

Returns:

The canPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws IOException,
                     AutomationException

Pastes the specified names into this object. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

paste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

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

Returns:

The successfulPaste

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadCachedObjects

public void loadCachedObjects()
                       throws IOException,
                              AutomationException

Loads any objects that should be cached for efficiency.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

loadCachedObjects in interface IGxCachedObjects

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseCachedObjects

public void releaseCachedObjects()
                          throws IOException,
                                 AutomationException

Releases any objects that have been cached for efficiency.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

releaseCachedObjects in interface IGxCachedObjects

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreateDataset

public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is created.

Remarks

The OnCreateDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onCreateDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRenameDataset

public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is renamed.

Remarks

The OnRenameDataset method is fired after a dataset has been renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onRenameDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteDataset

public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
                     throws IOException,
                            AutomationException

This event is fired when a dataset is deleted.

Remarks

The OnDeleteDataset method is fired after a dataset has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDeleteDataset in interface IWorkspaceEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDataElement getDataElement(IDEBrowseOptions browseOptions)
                            throws IOException,
                                   AutomationException

Get the GxObject's data element.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDataElement in interface IGxDataElement

Parameters:

browseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDataElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

retrieveDEFullProperties

public void retrieveDEFullProperties(IDataElement[] dataElement)
                              throws IOException,
                                     AutomationException

Retrieve the GxObject's heavy-weight properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

retrieveDEFullProperties in interface IGxDataElementHelper

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

retrieveDEBaseProperties

public void retrieveDEBaseProperties(IDataElement[] dataElement)
                              throws IOException,
                                     AutomationException

Retrieve the GxObject's light-weight properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

retrieveDEBaseProperties in interface IGxDataElementHelper

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeodatabaseName

public void getGeodatabaseName(String[] name)
                        throws IOException,
                               AutomationException

The Geodatabase name.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getGeodatabaseName in interface IGxGeodatabase

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachGeodatabase

public void detachGeodatabase()
                       throws IOException,
                              AutomationException

Detach a Geodatabase from a Data server.

Product Availability

Available with ArcGIS Desktop.

Specified by:

detachGeodatabase in interface IGxGeodatabase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

backup

public void backup(String backupName,
                   String backupFileName,
                   String description,
                   boolean[] isSimpleRecoveryModel)
            throws IOException,
                   AutomationException

Backs up a Geodatabase from a Data server.

Product Availability

Available with ArcGIS Desktop.

Specified by:

backup in interface IGxGeodatabase

Parameters:

backupName - The backupName (in)

backupFileName - The backupFileName (in)

description - The description (in)

isSimpleRecoveryModel - The isSimpleRecoveryModel (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public void getProperties(String[] owner,
                          Object[] creationDate,
                          int[] size,
                          String[] fileLocation,
                          Object[] lastBackup)
                   throws IOException,
                          AutomationException

Backup information.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getProperties in interface IGxGeodatabase

Parameters:

owner - The owner (out: use single element array)

creationDate - A Variant (out: use single element array)

size - The size (out: use single element array)

fileLocation - The fileLocation (out: use single element array)

lastBackup - A Variant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

upgrade

public void upgrade()
             throws IOException,
                    AutomationException

Upgrades Geodatabase.

Product Availability

Available with ArcGIS Desktop.

Specified by:

upgrade in interface IGxGeodatabase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataServerManager

public Object getDataServerManager()
                            throws IOException,
                                   AutomationException

The Data Server Manager object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDataServerManager in interface IGxGeodatabase

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.