Ens.Enterprise.MsgBank.Node

persistent class Ens.Enterprise.MsgBank.Node extends %Library.Persistent

SQL Table Name: Ens_Enterprise_MsgBank.Node

A class representing each client node the Message Bank Server knows about

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property Clone as %String [ Calculated , Transient , ReadOnly ];
Alphabet character to distingush multiple nodes connected simultaneously from different IP Adddresses
Property methods: CloneCompute(), CloneDisplayToLogical(), CloneGet(), CloneIsValid(), CloneLogicalToDisplay(), CloneLogicalToOdbc(), CloneNormalize(), CloneSQLCompute()
property ID as %Integer (MAXVAL = 999, MINVAL = 100) [ Required ];
3 digit internal node key number
Property methods: IDCheck(), IDDelete(), IDDisplayToLogical(), IDExists(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint(), IDSet()
property IPAddr as %String [ Calculated , Transient , ReadOnly ];
The IP Address portion of the IPAddress
Property methods: IPAddrCompute(), IPAddrDisplayToLogical(), IPAddrGet(), IPAddrIsValid(), IPAddrLogicalToDisplay(), IPAddrLogicalToOdbc(), IPAddrNormalize(), IPAddrSQLCompute(), IPAddressDisplayToLogical(), IPAddressGet(), IPAddressGetStored(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()
property IPAddress as %String);
The node's IP Address and port
Property methods: IPAddressDisplayToLogical(), IPAddressGet(), IPAddressGetStored(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()
property Instance as %String [ Calculated , Transient , ReadOnly ];
Instance name of the node
Property methods: InstanceCompute(), InstanceDisplayToLogical(), InstanceGet(), InstanceIsValid(), InstanceLogicalToDisplay(), InstanceLogicalToOdbc(), InstanceNormalize(), InstanceSQLCompute()
property Iteration as %String [ Calculated , Transient , ReadOnly ];
Number of times the MessageHeader ID counter has been reset on the node
Property methods: IterationCompute(), IterationDisplayToLogical(), IterationGet(), IterationIsValid(), IterationLogicalToDisplay(), IterationLogicalToOdbc(), IterationNormalize(), IterationSQLCompute()
property Machine as %String) [ Calculated , Transient , ReadOnly ];
Machine name of the node
Property methods: MachineCompute(), MachineDisplayToLogical(), MachineGet(), MachineIsValid(), MachineLogicalToDisplay(), MachineLogicalToOdbc(), MachineNormalize(), MachineSQLCompute()
property Name as %String) [ Required ];
composite Node name
Property methods: NameCheck(), NameCheckUnique(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet(), NamespaceCompute(), NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSQLCompute()
property Namespace as %String [ Calculated , ReadOnly ];
Namespace of the node
Property methods: NamespaceCompute(), NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSQLCompute()
property Port as %Integer [ Calculated , Transient , ReadOnly ];
The Port portion of the IPAddress
Property methods: PortCompute(), PortDisplayToLogical(), PortGet(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSQLCompute()
property TimeConnected as Ens.DataType.UTC;
The last time a Handshake was accepted from a client node
Property methods: TimeConnectedDisplayToLogical(), TimeConnectedGet(), TimeConnectedGetStored(), TimeConnectedIsValid(), TimeConnectedLogicalToDisplay(), TimeConnectedLogicalToOdbc(), TimeConnectedNormalize(), TimeConnectedOdbcToLogical(), TimeConnectedSet(), TimeConnectedStorageToLogical(), TimeConnectedtimeCmp(), TimeConnectedtimeDiff(), TimeConnectedtimeLocal(), TimeConnectedtimeLocaltoUTC(), TimeConnectedtimeUTC(), TimeConnectedtimeUTCH(), TimeConnectedtimeUTCHtoUTC(), TimeConnectedtimeUTCtoLocal(), TimeConnectedtimeUTCtoUTCH()
property TimeCreated as Ens.DataType.UTC [ InitialExpression = $$$timeUTC ];
Property methods: TimeCreatedDisplayToLogical(), TimeCreatedGet(), TimeCreatedGetStored(), TimeCreatedIsValid(), TimeCreatedLogicalToDisplay(), TimeCreatedLogicalToOdbc(), TimeCreatedNormalize(), TimeCreatedOdbcToLogical(), TimeCreatedSet(), TimeCreatedStorageToLogical(), TimeCreatedtimeCmp(), TimeCreatedtimeDiff(), TimeCreatedtimeLocal(), TimeCreatedtimeLocaltoUTC(), TimeCreatedtimeUTC(), TimeCreatedtimeUTCH(), TimeCreatedtimeUTCHtoUTC(), TimeCreatedtimeUTCtoLocal(), TimeCreatedtimeUTCtoUTCH()
property TimeUpdated as Ens.DataType.UTC;
The last time a change was stored to the IP and Port values
Property methods: TimeUpdatedDisplayToLogical(), TimeUpdatedGet(), TimeUpdatedGetStored(), TimeUpdatedIsValid(), TimeUpdatedLogicalToDisplay(), TimeUpdatedLogicalToOdbc(), TimeUpdatedNormalize(), TimeUpdatedOdbcToLogical(), TimeUpdatedSet(), TimeUpdatedStorageToLogical(), TimeUpdatedtimeCmp(), TimeUpdatedtimeDiff(), TimeUpdatedtimeLocal(), TimeUpdatedtimeLocaltoUTC(), TimeUpdatedtimeUTC(), TimeUpdatedtimeUTCH(), TimeUpdatedtimeUTCHtoUTC(), TimeUpdatedtimeUTCtoLocal(), TimeUpdatedtimeUTCtoUTCH()
property WebIPAddr as %String [ Calculated , Transient , ReadOnly ];
The IP Address portion of the WebServer
Property methods: WebIPAddrCompute(), WebIPAddrDisplayToLogical(), WebIPAddrGet(), WebIPAddrIsValid(), WebIPAddrLogicalToDisplay(), WebIPAddrLogicalToOdbc(), WebIPAddrNormalize(), WebIPAddrSQLCompute()
property WebPort as %Integer [ Calculated , Transient , ReadOnly ];
The Port portion of the WebServer
Property methods: WebPortCompute(), WebPortDisplayToLogical(), WebPortGet(), WebPortIsValid(), WebPortLogicalToDisplay(), WebPortNormalize(), WebPortSQLCompute()
property WebServer as %String);
The node's webserver IP Address, port, and URL root
Property methods: WebServerDisplayToLogical(), WebServerGet(), WebServerGetStored(), WebServerIsValid(), WebServerLogicalToDisplay(), WebServerLogicalToOdbc(), WebServerNormalize(), WebServerSet()
property WebURLRoot as %String [ Calculated , Transient , ReadOnly ];
The URL Root portion of the WebServer
Property methods: WebURLRootCompute(), WebURLRootDisplayToLogical(), WebURLRootGet(), WebURLRootIsValid(), WebURLRootLogicalToDisplay(), WebURLRootLogicalToOdbc(), WebURLRootNormalize(), WebURLRootSQLCompute()

Methods

private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked when the current object is added to the SaveSet, either because %Save() was invoked on this object or on an object that references this object. %OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking %AddToSaveSet or remove objects by calling %RemoveFromSaveSet.

If this method returns an error status then %Save() will fail and the transaction will be rolled back.

classmethod %OnAfterDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid has been deleted. The callback occurs immediately after %DeleteData has been called. If %DeleteData returns an error then %OnAfterDelete is not called.

If %OnAfterDelete returns an error (%Status) then the transaction is rolled back.

private method %OnAfterSave(insert As %Boolean) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Save() method to provide notification that the object is being saved. It is called after the object's data has been successfully written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save() will fail.

private method %OnNew(initvalue As %RawString) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

classmethod DeleteNodes(pUnusedOnly As %Boolean = 1, Output pNumDeleted As %Integer) as %Status [ Language = objectscript ]
classmethod GetNodeName(pNodeId As %Integer) as %String [ Language = objectscript ]
method GetWebIPAddrPort() as %String [ Language = objectscript ]
Return whatever IP address and port we can glean from all the properties

Indices

index (ID on ID) [IdKey, Type = key];
Index methods: IDCheck(), IDDelete(), IDDisplayToLogical(), IDExists(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint(), IDSet()
index (Name on Name) [Unique];
Index methods: NameCheck(), NameCheckUnique(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet(), NamespaceCompute(), NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSQLCompute()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Ens.Enterprise.MsgBank.Node)

^Ens.EntMsgBank.NodeD(ID)
=
%%CLASSNAME
Name
TimeCreated
TimeUpdated
TimeConnected
IPAddress
WebServer
Feedback