com.esri.arcgis.geodatabase
Class ILockInfoProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.ILockInfoProxy

All Implemented Interfaces:

ILockInfo, Externalizable, Serializable

public class ILockInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements ILockInfo, Serializable

Provides access to members that supply lock information.

Description

The ILockInfo interface provides the ability to detect what current users have version locks and if the lock is shared or exclusive. Locks imply that the users are currently editing the version or currently reconciling the version. This information can be used to determine if the version is available for editing, to be reconciled or to be reconciled against.

Product Availability

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

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getLockType() The type of lock the user acquired.
String	getUserName() The name of the user that acquired the lock.
void	removeListener(String iidStr, Object theListener)

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

ILockInfoProxy

public ILockInfoProxy()

ILockInfoProxy

public ILockInfoProxy(Object obj)
               throws IOException

Throws:

IOException

ILockInfoProxy

protected ILockInfoProxy(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

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

The name of the user that acquired the lock.

Remarks

The UserName method returns the user name who is currently editing or reconciling the version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserName in interface ILockInfo

Returns:

The user

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockType

public int getLockType()
                throws IOException,
                       AutomationException

The type of lock the user acquired.

Remarks

The LockType method returns the type of lock the current user has on the version. Shared locks are acquired upon start editing and released at stop editing. Shared locks are promoted to Exclusive locks during reconcile or when a version is being reconciled against.

The Exclusive lock prevents multiple reconciliations against any one version simultaneously. This will prevent unnecessary reconciles, in the case where the version is reconciled and the target version is modified. Which then forces a second reconciliation and can waste server/client resources.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLockType in interface ILockInfo

Returns:

A com.esri.arcgis.geodatabase.esriLockType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.