Namespace: Consultingwerk.SmartFramework.Lock
Interface 
ISmartLockService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.SmartFramework.Lock.SmartLockService


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
LOGICAL AcquireLock (character, character, integer, logical) Acquire logical application lock for a record
LOGICAL AcquireLock (character, integer, logical) Acquire logical application lock for a resource
INTEGER DeleteAllLocksOfUser (character) Deletes all SmartLock records of the given user
LOGICAL DeleteLock (character) Deletes the SmartLock record with the given LockGuid
INTEGER ExpireAllLocksOfUser (character) Expires all SmartLock records of the given user
LOGICAL ExpireLock (character) Expires the SmartLock record with the given LockGuid
ReleaseAllExpiredLocks () Delete all expired SmartLock record
ReleaseAllSessionLocks (character) Delete all SmartLock records of a session
LOGICAL ReleaseLock (character) Release a logical application lock for a record or a resource
LOGICAL ReleaseLock (character, character) Release a logical application lock for a record or a resource


Method Detail
Top

LOGICAL AcquireLock (character, character, integer, logical)
Purpose: Acquire logical application lock for a record
Notes: This method is only implemented by SmartLockService
Tries to create or update a SmartLock record

Parameters:
pcTableGuid CHARACTER
Reference to unique record in SmartTable
pcKeyValues CHARACTER
Values of a unique key field(s)
piLockDuration INTEGER
How long the lock may be hold in seconds
plThrowOnAlreadyLocked LOGICAL
Logical indication to throw a record ... or not
Returns LOGICAL
True if lock is given else false
Top

LOGICAL AcquireLock (character, integer, logical)
Purpose: Acquire logical application lock for a resource
Notes: This method is only implemented by SmartLockService
Tries to create or update a SmartLock record

Parameters:
pcResourceIdentifier CHARACTER
Resource only known to the one using it
piLockDuration INTEGER
How long the lock may be hold in seconds
plThrowOnAlreadyLocked LOGICAL
Logical indication to throw a record ... or not
Returns LOGICAL
True if lock is given else false
Top

INTEGER DeleteAllLocksOfUser (character)
Purpose: Deletes all SmartLock records of the given user
Notes: Administrative API used by the SmartLock management screen

Parameters:
pcUserGuid CHARACTER
The GUID of the user to delete the locks of
Returns INTEGER
The number of deleted SmartLock records
Top

LOGICAL DeleteLock (character)
Purpose: Deletes the SmartLock record with the given LockGuid
Notes: Administrative API used by the SmartLock management screen

Parameters:
pcLockGuid CHARACTER
The GUID of the SmartLock record to delete
Returns LOGICAL
True when the lock was found and deleted, else false
Top

INTEGER ExpireAllLocksOfUser (character)
Purpose: Expires all SmartLock records of the given user
Notes: Administrative API used by the SmartLock management screen
Sets LockExpires to now; the expired records are later removed
by the DeleteExpiredLocksJobCommand

Parameters:
pcUserGuid CHARACTER
The GUID of the user to expire the locks of
Returns INTEGER
The number of expired SmartLock records
Top

LOGICAL ExpireLock (character)
Purpose: Expires the SmartLock record with the given LockGuid
Notes: Administrative API used by the SmartLock management screen
Sets LockExpires to now; the expired record is later removed
by the DeleteExpiredLocksJobCommand

Parameters:
pcLockGuid CHARACTER
The GUID of the SmartLock record to expire
Returns LOGICAL
True when the lock was found and expired, else false
Top

ReleaseAllExpiredLocks ()
Purpose: Delete all expired SmartLock record
Notes: Called from the SmartScheduler

Top

ReleaseAllSessionLocks (character)
Purpose: Delete all SmartLock records of a session
Notes: Independently of the LockExpires datetime

Parameters:
pcSessionIdentifier CHARACTER
SessionId as provided by the SessionManager
Top

LOGICAL ReleaseLock (character)
Purpose: Release a logical application lock for a record or a resource
Notes: This method is only implemented by SmartLockService
Tries to delete a SmartLock record

Parameters:
pcResourceIdentifier CHARACTER
Resource only known to the one using it
Returns LOGICAL
True if lock is found and released else false
Top

LOGICAL ReleaseLock (character, character)
Purpose: Release a logical application lock for a record or a resource
Notes: This method is only implemented by SmartLockService
Tries to delete a SmartLock record

Parameters:
pcTableGuid CHARACTER
Reference to unique record in SmartTable
pcKeyValues CHARACTER
Values of a unique key field(s)
Returns LOGICAL
True if lock is found and released else false


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       06.08.2026 11:35:46