%SYS.Journal.SetKillRecord

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

SQL Table Name: %SYS_Journal.SetKillRecord

Journal SET/KILL record related API

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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

Properties

property ClusterSequence as %Integer [ Calculated ];
Cluster journal sequence number of the record on a clustered system or 0 otherwise
Property methods: ClusterSequenceDisplayToLogical(), ClusterSequenceGet(), ClusterSequenceIsValid(), ClusterSequenceLogicalToDisplay(), ClusterSequenceNormalize()
property Collation as %Integer [ Calculated ];
The collation of the subscripts in GlobalNode
Property methods: CollationDisplayToLogical(), CollationGet(), CollationIsValid(), CollationLogicalToDisplay(), CollationNormalize()
property DatabaseName as %SysPath [ Calculated ];
Directory path of the database updated by the SET or KILL
Property methods: DatabaseNameDisplayToLogical(), DatabaseNameGet(), DatabaseNameIsValid(), DatabaseNameLogicalToDisplay(), DatabaseNameLogicalToOdbc(), DatabaseNameNormalize()
property GlobalNode as %VarString [ Calculated ];
Global node of the SET or KILL (GlobalReference minus the namespace)
Property methods: GlobalNodeDisplayToLogical(), GlobalNodeGet(), GlobalNodeIsValid(), GlobalNodeLogicalToDisplay(), GlobalNodeLogicalToOdbc(), GlobalNodeNormalize()
property GlobalReference as %VarString [ Calculated ];
Extended global reference of the SET or KILL
Property methods: GlobalReferenceDisplayToLogical(), GlobalReferenceGet(), GlobalReferenceIsValid(), GlobalReferenceLogicalToDisplay(), GlobalReferenceLogicalToOdbc(), GlobalReferenceNormalize()
property MirrorDatabaseName as %String [ Calculated ];
Mirror database name of the database updated by the SET or KILL if it is a mirrored database
Property methods: MirrorDatabaseNameDisplayToLogical(), MirrorDatabaseNameGet(), MirrorDatabaseNameIsValid(), MirrorDatabaseNameLogicalToDisplay(), MirrorDatabaseNameLogicalToOdbc(), MirrorDatabaseNameNormalize()
property NewValue as %VarString [ Calculated ];
(For SET record only) The value the global node was set to
Property methods: NewValueDisplayToLogical(), NewValueGet(), NewValueIsValid(), NewValueLogicalToDisplay(), NewValueLogicalToOdbc(), NewValueNormalize()
property NumberOfValues as %Integer [ Calculated ];
Number of data values stored in the record. It can be 0, 1 or 2 depending on whether the record is a SET or KILL and whether it is in a transaction.
Property methods: NumberOfValuesDisplayToLogical(), NumberOfValuesGet(), NumberOfValuesIsValid(), NumberOfValuesLogicalToDisplay(), NumberOfValuesNormalize()
property OldValue as %VarString [ Calculated ];
(For InTransaction record only) The value of the global node prior to the SET or KILL
Property methods: OldValueDisplayToLogical(), OldValueGet(), OldValueIsValid(), OldValueLogicalToDisplay(), OldValueLogicalToOdbc(), OldValueNormalize()

Methods

private method %LoadData(Offset As %String, flag As %Boolean) as %Status [ Language = objectscript ]
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
method ClusterSequenceGet() as %Integer [ Language = objectscript ]
method CollationGet() as %Integer [ Language = objectscript ]
method DatabaseNameGet() as %String [ Language = objectscript ]
method ExistsNewValue() as %Boolean [ Language = objectscript ]
TRUE if there is a NewValue (including "") in the record
method ExistsOldValue() as %Boolean [ Language = objectscript ]
TRUE if there is an OldValue (including "") in the record
method GlobalNodeGet() as %String [ Language = objectscript ]
method GlobalReferenceGet() as %String [ Language = objectscript ]
method MirrorDatabaseNameGet() as %String [ Language = objectscript ]
method NewValueGet() as %String [ Language = objectscript ]
method NumberOfValuesGet() as %Integer [ Language = objectscript ]
method OldValueGet() as %String [ Language = objectscript ]
method Restore(Detail As %Integer) as %Status [ Language = objectscript ]
Restore a SET or KILL

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Subclasses

Feedback