Skip to main content

%SYS.Journal.Marker

Class %SYS.Journal.Marker Extends %SYS.Journal.Record [ System = 4 ]

Journal marker related API

Parameters

READONLY

Parameter READONLY = 1;

Properties

info

Property info As %VarString [ Private ];

MID

Property MID As %Integer [ Calculated ];

Marker ID (or Marker Type)

Sequence

Property Sequence As %Integer [ Calculated ];

Cluster journal sequence number of the marker on a clustered system or 0 otherwise

Text

Property Text As %VarString [ Calculated ];

Text string associated with the marker

PrevMarker

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

Methods

%LoadData

Method %LoadData(Offset As %String, flag As %Boolean) As %Status [ Private ]

MIDGet

Method MIDGet() As %Integer

SequenceGet

Method SequenceGet() As %Integer

TextGet

Method TextGet() As %String

PrevMarkerGet

Method PrevMarkerGet() As %SYS.Journal.Marker

Fetch

Method Fetch(ByRef Row As %List, ByRef Columns As %String, Match As %List = "") As %Boolean [ Internal, PublicList = (col, match, Row, Columns) ]

TranslateType

ClassMethod TranslateType(ID As %Integer) As %String

Translate the numeric marker type (MID) to the string form

MarkerListExecute

ClassMethod MarkerListExecute(ByRef qHandle As %Binary, FileName As %SysPath = "", Offset As %Integer = 0) As %Status

Returns a list of journal markers

MarkerListFetch

ClassMethod MarkerListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status

MarkerListClose

ClassMethod MarkerListClose(ByRef qHandle As %Binary) As %Status