com.esri.arcgis.system
Interface IAfLockMgr

All Superinterfaces:

Serializable

All Known Implementing Classes:

AfLockMgr

public interface IAfLockMgr
extends Serializable

Provides access to members that work with the application lock manager.

Product Availability

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

Method Summary

boolean	checkLock(String fileName, int lockMgrType) Indicates if the specified lock type can be sucessfully set on the filename.
boolean	clearLock(String fileName, int lockMgrType) Clears the specified lock type from the filename.
void	isAlive() Indicates if a local lock manager process is active.
boolean	isGlobalAlive() Indicates if a global lock manager process is active.
boolean	register() Registers object with the lock manager and starts the lock manager process if it is not running.
boolean	setLock(String fileName, int lockMgrType) Places the selected lock type on the given filename.
boolean	unregister() Unregisters object from the lock manager and removes all locks set by the object.

Method Detail

isAlive

void isAlive()
             throws IOException,
                    AutomationException

Indicates if a local lock manager process is active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobalAlive

boolean isGlobalAlive()
                      throws IOException,
                             AutomationException

Indicates if a global lock manager process is active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pbGlobalAlive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

register

boolean register()
                 throws IOException,
                        AutomationException

Registers object with the lock manager and starts the lock manager process if it is not running.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unregister

boolean unregister()
                   throws IOException,
                          AutomationException

Unregisters object from the lock manager and removes all locks set by the object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLock

boolean setLock(String fileName,
                int lockMgrType)
                throws IOException,
                       AutomationException

Places the selected lock type on the given filename.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fileName - The fileName (in)

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

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkLock

boolean checkLock(String fileName,
                  int lockMgrType)
                  throws IOException,
                         AutomationException

Indicates if the specified lock type can be sucessfully set on the filename.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fileName - The fileName (in)

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

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearLock

boolean clearLock(String fileName,
                  int lockMgrType)
                  throws IOException,
                         AutomationException

Clears the specified lock type from the filename.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fileName - The fileName (in)

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

Returns:

The succeeded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.