com.esri.arcgis.system
Interface IAppLockMgr

All Superinterfaces:
Serializable
All Known Implementing Classes:
AppLockMgr

public interface IAppLockMgr
extends 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.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(IAfLockMgr pAfLockMgr, int pID, int[] cookie)
          Adds an application reference to the lock manager.
 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 setLock(int cookie, String fileName, int lockMgrType)
          Sets a lock within the lock manager.
 

Method Detail

add

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

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

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

Parameters:
cookie - The cookie (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

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

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobalAlive

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

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

void setLock(int cookie,
             String fileName,
             int lockMgrType)
             throws IOException,
                    AutomationException
Sets a lock within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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

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

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

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.