com.esri.arcgis.geodatabase
Interface IDatabaseConnectionInfo4

All Superinterfaces:

IDatabaseConnectionInfo, IDatabaseConnectionInfo2, IDatabaseConnectionInfo3, Serializable

public interface IDatabaseConnectionInfo4
extends IDatabaseConnectionInfo3, Serializable

Provides access to members that provide information about the Workspace's connected database.

Product Availability

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

Method Summary

String	generateDefaultRealm() The default qualifier used to create fully qualified names for Editor Tracking.
Object	getConnectionCurrentDateTimeInUTC() The current UTC date/time.
String	getRealm() The realm used to create fully qualified names for Editor Tracking.
void	setRealm(String realm) The realm used to create fully qualified names for Editor Tracking.

Methods inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo3

disconnectUser, getConnectedDatabaseEx, getConnectedUsers, isAcceptingConnections, setIsAcceptingConnections

Methods inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo2

getConnectionCurrentDateTime, getConnectionDBMS, getConnectionServer, getGeodatabaseServerClass

Methods inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo

getConnectedDatabase, getConnectedUser

Method Detail

setRealm

void setRealm(String realm)
              throws IOException,
                     AutomationException

The realm used to create fully qualified names for Editor Tracking.

Description

Realm sets the realm for a workspace for use in editor tracking.

Remarks

If your data resides in an ArcSDE geodatabase and you connect through database authentication, you can choose to append a realm (for example, @esri.com) to the name of the user who makes the edit. For example, if you have a user named John in your Denver office and a user named John in your Seattle office, you can track their edits as John@denver and John@seattle, respectively, so that you can be certain which John made each edit.

To set the realm for an ArcSDE geodatabase, you must have administrator privileges on the database.

When setting a realm, you can set either a custom realm which can be any string, or a default realm provided for you. To set a custom realm, set IDatabaseConnectionInfo4.Realm to any string. To set a default realm, set IDatabaseConnectionInfo4.Realm to the string returned by GenerateDefaultRealm.

Product Availability

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

Parameters:

realm - The realm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRealm

String getRealm()
                throws IOException,
                       AutomationException

The realm used to create fully qualified names for Editor Tracking.

Description

Realm returns the realm that is currently set for a workspace.

Remarks

Realm is the string appended to the user name as it is recorded into the editor tracking creator and last editor fields.

Product Availability

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

Returns:

The realm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateDefaultRealm

String generateDefaultRealm()
                            throws IOException,
                                   AutomationException

The default qualifier used to create fully qualified names for Editor Tracking.

Description

GenerateDefaultRealm returns a default realm for a workspace for use in editor tracking.

Remarks

When setting a realm, you can set either a custom realm which can be any string, or a default realm you can retrieve with GenerateDefaultRealm. To set a default realm, set IDatabaseConnectionInfo4.Realm to the string returned by GenerateDefaultRealm.

Product Availability

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

Returns:

The defaultRealm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionCurrentDateTimeInUTC

Object getConnectionCurrentDateTimeInUTC()
                                         throws IOException,
                                                AutomationException

The current UTC date/time.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.