RecordLockingConflict class

The RecordLockingConflict exception class catches record locking conflict errors thrown by file object operations, that is, from methods in the file classes (Record, Recordset, SortedRecordset, and RecordsetCursor).

Summary

A RecordLockingConflict exception is thrown only if there is a Catcher for the exception. This allows On Record Locking Conflict and On Find Conflict units to trap record locking conflicts if there is no Catch block for the exception.

There is no distinction between a Find conflict and a Record Locking conflict. For example, you can use the following:

try fd to %foo ... end find catch recordLockingConflict ... end try

And you can also use:

try %rec = new(%recnum, exclusive) for record %rec ... end for catch recordLockingConflict ... end try

You can even catch record locking conflicts caused by LoopLockStrength promotions during a loop:

%rec = new(%recnum, none, loopLockStrength=share) ... try for record %rec ... end for catch recordLockingConflict ... end try

Or as in the following:

%curser = new(%recset, loopLockStrength=none) ... try for record at cursor %curser ... end for catch recordLockingConflict .. end try

Or as in this example:

fdwol to %recset = new(loopLockStrength=exclusive) ... end find ... try for each record in %recset ... end for catch recordLockingConflict ... end try

In the latter example, note that any iteration of the For loop can throw an exception, and there is no way of picking up where you left off (at the next record, say) if you get a RecordLockingConflict exception in such a case. So, unless you always want to lose the whole loop on a record locking conflict, such a case is almost always better structured with a cursor on the recordset and with Try around the For Record At Cursor loop:

fdwol to %recset = new(loopLockStrength=exclusive) ... end find ... %curser = new(%recset, loopLockStrength=exclusive) repeat while %curser:state eq hasRecord try for record at cursor %curser ... end for catch recordLockingConflict ... end try %curser:next end repeat

Note: The For statement can be on the same line as the Try, or it can be inside the Try block.

The RecordLockingConflict methods

The following are the available RecordLockingConflict class methods.

Method	Description
ConflictTimeMilliseconds	Time that the conflict occurred
ConflictingLockStrength	Lock strength of conflicting lock
ConflictingRecordLockType	Lock type of conflicting lock
Copy	Copy the RecordLockingConflict object
DeepCopy	Deep copy the RecordLockingConflict object
Filename	Name of the file in which last record locking conflict occurred
LockTimeMilliseconds	Time that the conflicting record was locked
LockingUserNumber	User number of the user that locked the conflicting record
New	Create a new RecordLockingConflict object
NewFromLastConflict	Create object from current conflict information
RecordNumber	Record number of the record that has the conflict
UserID	User ID (login name) of the user that has the conflict
UserNumber	User number of the user that has the conflict

The methods in the class are described in the subsections that follow. In addition:

• Notation conventions for methods has information about the conventions followed.
• RecordLockingConflict methods syntax is a single page that contains the syntax diagrams of all the methods in the class.

ConflictingLockStrength property

Lock strength of conflicting lock (RecordLockingConflict class)

This ReadOnly method returns a LockStrength enumeration value indicating the strength of the lock held by another user that caused the conflict.

Syntax

%lockStrength = recordLockingConflict:ConflictingLockStrength

Syntax terms

%lockStrength	A variable to receive the output value, a LockStrength enumeration value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• If the RECLOCKO parameter X'04' bit is not set, this property returns a Null value.
• Since an unlocked record (LockStrength None) cannot cause a record locking conflict, a non-Null return value should always be either Share or Exclusive.

ConflictingRecordLockType property

Lock type of conflicting lock (RecordLockingConflict class)

This ReadOnly method returns a RecordLockType enumeration value indicating the type of the lock held by another user that caused the conflict.

Syntax

%recordLockType = recordLockingConflict:ConflictingRecordLockType

Syntax terms

%recordLockType	A variable to receive the output value, a RecordLockType enumeration value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• If the RECLOCKO parameter X'04' bit isn't set, this property will return a Null value.

ConflictTimeMilliseconds property

Time that the conflict occurred (RecordLockingConflict class)

This ReadOnly property returns a number that is the number of milliseconds since 1900 that the record locking conflict occurred.

Syntax

%number = recordLockingConflict:ConflictTimeMilliseconds

Syntax terms

%number	A variable to receive the output value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• If the RECLOCKO parameter X'04' bit is not set, this property returns a 0 value.
• The MillisecondsToString method can be used to convert this value to a more human-friendly format.

Copy and DeepCopy functions

Copy the RecordLockingConflict object (RecordLockingConflict class)

Deep copy the RecordLockingConflict object (RecordLockingConflict class)

These functions return a copy of the method object, that is the RecordLockingConflict object to which they are applied.

Syntax

%outRecordLockingConflict = recordLockingConflict:Copy

%outRecordLockingConflict = recordLockingConflict:DeepCopy

Syntax terms

%outRecordLockingConflict	A RecordLockingConflict object variable to receive the output value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• Since RecordLockingConflict objects contain no references to other objects, there is no difference between a Copy and DeepCopy method for these objects.
• The presence of a DeepCopy method for the RecordLockingConflict class means that classes that contain references to RecordLockingConflict objects can also be DeepCopy-able.

Filename property

Name of the file in which last record locking conflict occurred (RecordLockingConflict class)

This ReadOnly property returns a Longstring that contains the name of the file in which the last record locking conflict occurred.

Syntax

%string = recordLockingConflict:Filename

Syntax terms

%string	A longstring to receive the file name.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

LockTimeMilliseconds property

Time that the conflicting record was locked (RecordLockingConflict class)

This ReadOnly property returns a number that is the number of milliseconds since 1900 that the record that caused the record locking conflict was locked.

Syntax

%number = recordLockingConflict:LockTimeMilliseconds

Syntax terms

%number	A variable to receive the output value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• If the RECLOCKO parameter X'04' bit is not set, this property returns a 0 value.
• The MillisecondsToString method can be used to convert this value to a more human-friendly format.
• LockingTimeMilliseconds, along with the LockingUserNumber property should make it relatively easy to locate the request that locked the record that caused the record lock in the audit trail.
• Strictly speaking, the returned lock time is the time the finding and locking process began for the locked record, not when it was actually locked. Since the primary purpose this value is to locate audit trail information for the request that locked the conflicting record, and since the entire locking process always happens within a single request, this distinction should be relatively unimportant.

LockingUserNumber property

User number of the user that locked the conflicting record (RecordLockingConflict class)

This ReadOnly property returns the user number of the user that originally locked the conflicting record. This might be different from the value returned by the UserNumber property if a file object is passed between threads as a session object. In fact, a record lock caused by a file object in a closed session would return the session PST's user number for UserNumber but would return the user number that originally locked the record that caused the conflict.

Syntax

%number = recordLockingConflict:LockingUserNumber

Syntax terms

%number	A variable to receive the output value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Usage notes

• If the RECLOCKO parameter X'04' bit is not set, this property returns a -1 value.
• LockingUserNumber, along with the LockTimeMilliseconds property should make it relatively easy to locate the request that locked the record that caused the record lock in the audit trail.

New constructor

Create a new RecordLockingConflict object (RecordLockingConflict class)

This Constructor generates an instance of a RecordLockingConflict exception. As shown in the syntax that follows, the New method arguments set the values of the class properties having the corresponding names. Each argument to New sets the value of the corresponding property of the newly constructed RecordLockingConflict object.

Syntax

%recordLockingConflict = [%(RecordLockingConflict):]New( Filename= string, - RecordNumber= number, - UserNumber= number, - UserID= string, - [LockingUserNumber= number], - [LockTimeMilliseconds= number], - [ConflictTimeMilliseconds= number], - [ConflictingLockStrength= lockStrength], - [ConflictingRecordLockType= recordLockType])

Syntax terms

%recordLockingConflict	A reference to an instance of a RecordLockingConflict object.
[%(RecordLockingConflict):]	The class name in parentheses denotes a Constructor.
Filename	This name required parameter specifies the Longstring value (string) to be assigned to the object's Filename property. Its default value is a null string.
RecordNumber	This name required parameter specifies the numeric value (number) to be assigned to the object's RecordNumber property. Its default value is 0.
UserNumber	This name required parameter specifies the numeric value (number) to be assigned to the exception object's UserNumber property. Its default value is 0.
UserID	This name required parameter specifies the longstring value (string) to be assigned to the object's UserID property. Its default value is a null string.
LockingUserNumber	This optional, name required parameter specifies the numeric value (number) to be assigned to the object's LockingUserNumber property. Its default value is -1, which is not a valid user number, and is the value set for the LockingUserNumber property by the system when the RECLOCKO parameter X'04' bit is not set and a RecordLockingConflict exception is thrown.
LockTimeMilliseconds	This optional, name required parameter specifies the numeric value (number) to be assigned to the object's LockTimeMilliseconds property. Its default value is a 0, which is the value set for the LockTimeMilliseconds property by the system when the RECLOCKO parameter X'04' bit is not set and a RecordLockingConflict exception is thrown.
ConflictTimeMilliseconds	This optional, name required parameter specifies the numeric value (number) to be assigned to the object's ConflictTimeMilliseconds property. Its default value is a 0, which is the value set for the ConflictTimeMilliseconds property by the system when the RECLOCKO parameter X'04' bit is not set and a RecordLockingConflict exception is thrown.
ConflictingLockStrength	This optional, name required parameter specifies the LockStrength enumeration value to be assigned to the object's ConflictingLockStrength property. Its default value is a Null, which is the value set for the ConflictingLockStrength property by the system when the RECLOCKO parameter X'04' bit is not set and a RecordLockingConflict exception is thrown. Since a record locking conflict cannot be caused by an unlocked record, setting this value to None is equivalent to setting it to Null.
ConflictingRecordLockType	This optional, name required parameter specifies the RecordLockType enumeration value to be assigned to the object's ConflictingRecordLockType property. Its default value is a Null, which is the value set for the ConflictingRecordLockType property by the system when the RECLOCKO parameter X'04' bit is not set and a RecordLockingConflict exception is thrown.

NewFromLastConflict constructor

Create object from current conflict information (RecordLockingConflict class)

This Constructor generates an instance of an RecordLockingConflict exception. Unlike the New method, this method obtains the values of the object properties from the last record locking conflict that occurred, whether or not it was trapped (caught or handled by an On unit). In fact, the greatest utility of this method would be to create a RecordLockingConflict instance that contains all record locking information in an On Record Locking Conflict or On Find Conflict unit. This is especially useful for accessing the properties set by the RECLOCKO parameter X'04' bit in an On unit. These properties are LockingUserNumber, LockTimeMilliseconds, ConflictTimeMilliseconds, ConflictingLockStrength, and ConflictingRecordLockType.

Syntax

%reclockInfo = [%(RecordLockingConflict):]NewFromLastConflict

Syntax terms

%reclockInfo	A reference to an instance of a RecordLockingConflict object.
[%(RecordLockingConflict):]	The class name in parentheses denotes a Constructor.

Usage notes

• If there have been no record locking conflicts in the current request, this method returns a Null.
• Since Model 204 clears the record locking conflict information at the start of each request, this method cannot be used to retrieve information from a previous request.

RecordNumber property

Record number of the record that has the conflict (RecordLockingConflict class)

This ReadOnly property returns the numeric value of the Model 204 internal record number of the record that has the conflict.

Syntax

%number = recordLockingConflict:RecordNumber

Syntax terms

%number	A numeric variable to receive the record number.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

Example

The following example shows all the properties of the RecordLockingConflict class. While the standard record locking conflict information is available for retrieval via the SOUL functions $RlcFile, $RlcRec, $RlcUid, and $RlcUsr, that information is also set in the exception object and retrievable via that object:

%rlc is object RecordLockingConflict ... %rec = new(%recnum, none, loopLockStrength=share) ... try for record %rec ... end for catch recordLockingConflict to %rlc auditText Conflict on record {%rlc:recordNumber} - in file {%rlc:filename} auditText Conflicting user was userid {%rlc:userid}, - with user number:{%rlc:userNumber} end try

UserID property

User ID (login name) of the user that has the conflict (RecordLockingConflict class)

This ReadOnly property returns the Model 204 userid (login name) of the user that has the conflict.

Syntax

%string = recordLockingConflict:UserID

Syntax terms

%string	A longstring to receive the userid value.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.

UserNumber property

User number of the user that has the conflict (RecordLockingConflict class)

This ReadOnly property returns the user number (unique per session) of the user that has the conflict.

Syntax

%number = recordLockingConflict:UserNumber

Syntax terms

%number	A numeric variable to receive the user number.
recordLockingConflict	A reference to an instance of a RecordLockingConflict object.