Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %SYS.Journal.Marker
Private  Storage   

%SYS.Journal.Marker


persistent class %SYS.Journal.Marker extends
%SYS.Journal.Record

Journal marker related API

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5 10 1


Summary


Properties
Address ECPSystemID InTransaction JobID MID
Next NextAddress Prev PrevAddress PrevMarker
ProcessID RemoteSystemID Sequence Text TimeStamp
Type TypeName

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Exists %ExistsId %Extends
%GUID %GUIDSet %GetLock %GetParameter
%GetSwizzleObject %Id %IsA %IsModified
%IsNull %KillExtent %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull %ObjectModified
%Oid %OnBeforeAddToSync %OnDetermineClass %Open
%OpenId %OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
Count ECPSystemIDGet GetAddressNear GetPhysicalLocation
GetRealPIDSYSinFilter InTransactionGet JobIDGet MIDGet
MarkerListClose MarkerListExecute MarkerListFetch NextAddressGet
NextGet PIDLookup PrevAddressGet PrevGet
PrevMarkerGet ProcessIDGet RemoteSystemIDGet Restore
SequenceGet TextGet TimeStampGet TranslateType
TypeNameGet


Parameters


• parameter READONLY = 1;
READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties


• property MID as %Integer [ Calculated ];
Marker ID (or Marker Type)
• property PrevMarker as %SYS.Journal.Marker [ Calculated ];
Object reference to the previous marker in the journal file or NULLOREF if this is the first marker
• property Sequence as %Integer [ Calculated ];
Cluster journal sequence number of the marker on a clustered system or 0 otherwise
• property Text as %VarString [ Calculated ];
Text string associated with the marker

Methods


• method MIDGet() as %Integer
This is a Get accessor method for the MID property.
• classmethod MarkerListClose(ByRef qHandle As %Binary) as %Status
• classmethod MarkerListExecute(ByRef qHandle As %Binary, FileName As %SysPath = "", Offset As %Integer = 0) as %Status
• classmethod MarkerListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• method PrevMarkerGet() as %SYS.Journal.Marker
This is a Get accessor method for the PrevMarker property.
• method SequenceGet() as %Integer
This is a Get accessor method for the Sequence property.
• method TextGet() as %String
This is a Get accessor method for the Text property.
• classmethod TranslateType(ID As %Integer) as %String
Translate the numeric marker type (MID) to the string form

Queries


• query MarkerList(FileName As %SysPath, Offset As %Integer)
Selects File Offset As %Integer, Cluster Sequence Number As %Integer, Type As %Integer, Text As %String, Time As %TimeStamp
Returns a list of journal markers