com.esri.arcgis.system
Class IAppLockMgrProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.system.IAppLockMgrProxy

All Implemented Interfaces:

IAppLockMgr, Externalizable, Serializable

public class IAppLockMgrProxy
extends com.esri.arcgis.interop.Dispatch
implements IAppLockMgr, Serializable

Provides access to members that control the application lock manager.

Remarks

The AppLockMgr coclass is used to control locks on shapefiles and coverages, so no two users can make changes to the same dataset. It is pretty much the same idea as with relational database’s lock to prevent multiple users from making conflicting modifications to a set of data. Lock types are specified by esriLockMgrType enumerator.

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

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

Method Summary

void	add(IAfLockMgr pAfLockMgr, int pID, int[] cookie) Adds an application reference to the lock manager.
void	addListener(String iidStr, Object theListener, Object theSource)
void	checkLock(int cookie, String fileName, int lockMgrType) Checks for a lock within the lock manager.
void	clearLock(int cookie, String fileName, int lockMgrType) Clears a lock from within the lock manager.
int	getCount() The current count of locks within the lock manager.
void	isGlobalAlive(boolean[] pbGlobalAlive) Indicates if the global lock manager is active.
void	remove(int cookie) Removes a lock reference from the lock manager.
void	removeListener(String iidStr, Object theListener)
void	setLock(int cookie, String fileName, int lockMgrType) Places a lock within the lock manager.

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

IAppLockMgrProxy

public IAppLockMgrProxy()

IAppLockMgrProxy

public IAppLockMgrProxy(Object obj)
                 throws IOException

Throws:

IOException

IAppLockMgrProxy

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

add

public void add(IAfLockMgr pAfLockMgr,
                int pID,
                int[] cookie)
         throws IOException,
                AutomationException

Adds an application reference to the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IAppLockMgr

Parameters:

pAfLockMgr - A reference to a com.esri.arcgis.system.IAfLockMgr (in)

pID - The pID (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int cookie)
            throws IOException,
                   AutomationException

Removes a lock reference from the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The current count of locks within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IAppLockMgr

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobalAlive

public void isGlobalAlive(boolean[] pbGlobalAlive)
                   throws IOException,
                          AutomationException

Indicates if the global lock manager is active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGlobalAlive in interface IAppLockMgr

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLock

public void setLock(int cookie,
                    String fileName,
                    int lockMgrType)
             throws IOException,
                    AutomationException

Places a lock within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkLock

public void checkLock(int cookie,
                      String fileName,
                      int lockMgrType)
               throws IOException,
                      AutomationException

Checks for a lock within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

checkLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearLock

public void clearLock(int cookie,
                      String fileName,
                      int lockMgrType)
               throws IOException,
                      AutomationException

Clears a lock from within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.