Returns the update sequence number (USN) for this object.

You can use the returned value to determine if the object has been modified since some earlier fetch of the same object.

An IndependentlyPersistableObject has an update sequence number (USN), which is an Integer value on the object that protects it against concurrent updates. The USN value increases monotonically with each update to the object. When you update the object, the USN from the retrieved object is checked against the currently persisted USN value. If the values are different, the operation fails.

As a special case, a USN value of Null causes the server-side check to be skipped during updates (this is sometimes called "unprotected update"). An IndependentlyPersistableObject instantiated by calling one of the GetInstance methods on a Factory class (such as Factory.CustomObject.GetInstance) does not fetch the object from the server, and therefore, is unaware of the persisted USN. Calling GetUpdateSequence on such an object returns Null.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Function GetUpdateSequenceNumber() As Nullable(Of Integer)
C#
Nullable<int> GetUpdateSequenceNumber()
C++
Nullable<int> GetUpdateSequenceNumber() abstract 
J#
Nullable<int> GetUpdateSequenceNumber()
JScript
function GetUpdateSequenceNumber() : Nullable<int>

Return Value

An integer representing the update sequence number (USN).

See Also