IGLib
1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
|
Base class for all messages. More...
Public Member Functions | |
void | SetSenderLabex () |
Sets msg data such that sender is Labex and receiver is Bis. More... | |
void | SetSenderBis () |
Sets msg data such that sender is Bis and receiver is Labex. More... | |
![]() | |
virtual void | Save (string filename) |
Saves contents of the msg to an xml file. More... | |
virtual void | CreateXml () |
Creates msg Xml from the current msg data and stores it in this object. More... | |
virtual void | Load (string filename) |
Loads msg data from a file containing the XML msg. More... | |
virtual void | LoadXml (string doc) |
Loads msg data from a string containing the XML msg. More... | |
virtual void | LoadXml (XmlDocument doc) |
Loads msg data from an XmlDocument containing XML msg. More... | |
abstract void | Read () |
Reads msg data from the internal XML document containing the msg. More... | |
abstract void | Read (XmlParser data) |
Read msg data from an XML document containing the msg. More... | |
virtual void | CheckConsistency (AccummulatedReport rep) |
Empty data consistency check, intended to be overridden in derived classes. More... | |
virtual void | WriteToConsole () |
Writes cntents of the msg in a human readable form to the system console. More... | |
virtual void | Write (string filename, bool append) |
Writes cntents of the msg in a human readable form to a file. More... | |
abstract XmlDocument | ToXml () |
Converts a msg to Xml and returns it. More... | |
Static Public Member Functions | |
static void | SetMessageReceiverOld (ref XmlDocument msg, string receiver, out bool changed) |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. WARNING: searching for receiver element is done through an XPath expression, which may fail due to default namespaces that were not detected. More... | |
static void | SetMessageReceiver (ref string message, string receiver, out bool changed) |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More... | |
static void | SetMessageReceiver (ref XmlDocument msg, string receiver, out bool changed) |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More... | |
static void | SetMessageReceiver (ref XmlBuilder data, string receiver, out bool changed) |
Sets the receiver of the communication msg stored in an Xml builder to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More... | |
static void | SetMessageSender (ref XmlBuilder data, string sender, out bool changed) |
Sets the sender of the communication msg stored in an Xml builder to the specified sender, and indicates through an output argument whether the sender has been changed in msg. If the Sender stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More... | |
static void | SetMessageResponder (ref XmlBuilder data, string responder, out bool changed) |
Sets the responder of the communication msg stored in an Xml builder to the specified responder, and indicates through an output argument whether the responder has been changed in msg. If the responder stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More... | |
static MessageType | GetMessageType (string msgstring) |
Infers the msg type from the XML string containing the msg, and returns it. More... | |
static MessageType | GetMessageType (XmlDocument msg) |
Infers the msg type from the XML document containing the msg, and returns it. More... | |
static MessageType | GetMessageType (XmlParser data) |
Infers the msg type from the XML parser containing the msg, and returns it. More... | |
Public Attributes | |
MessageType | Type = MessageType.Unknown |
Message type. Helps with general methods that operate on any datatype of msg. More... | |
string | MessageId = null |
Message ID, obtained form the web service. More... | |
string | MessageFile = null |
Specifies the file where message has been backed up. Warning: this file may be deleted at any time! More... | |
string | MessageNumber = null |
![]() | |
string | XmlString = null |
Static Protected Attributes | |
static string | LabexIdLowercase = null |
Properties | |
static MsgConst | Const [get] |
Gets objects that contains all constants related to communication messages. More... | |
string | MessageXml [get, set] |
Complete msg as obtained from the web service. More... | |
![]() | |
virtual IReporter | R [get] |
Reporter for this class. More... | |
XmlDocument | Doc [get] |
Returns the XML document representing the msg. More... | |
Static Private Member Functions | |
static bool | IsSpecimenObservationOrder (XmlParser data) |
Returns true if data contains a msg of type MessageType.SpecimenObservationOrder. More... | |
static bool | IsSpecimenObservationEvent (XmlParser data) |
Returns true if data contains a msg of type MessageType.SpecimenObservationEvent. More... | |
static bool | IsDetailedFinancialTransaction (XmlParser data) |
Returns true if data contains a msg of type MessageType.DetailedFinancialTransaction. More... | |
Private Attributes | |
string | MessageNumberOid = null |
string | MessageReceiver = null |
string | MessageReceiverOid = null |
string | MessageResponder = null |
string | MessageResponderOid = null |
string | MessageSender = null |
string | MessageSenderOid = null |
Static Private Attributes | |
static string | BisIdLowercase = null |
Additional Inherited Members | |
![]() | |
XmlBuilder | Data = new XmlBuilder() |
Base class for all messages.
|
inline |
Sets msg data such that sender is Labex and receiver is Bis.
References IG.Lib.MsgConst.Const, and IG.Lib.MsgConstCommon.LabexId.
Referenced by IGTest.ProgramIGTest.TestMsgFinancialTransaction(), and IGTest.ProgramIGTest.TestMsgObservationEvent().
|
inline |
Sets msg data such that sender is Bis and receiver is Labex.
References IG.Lib.MsgConst.Const, and IG.Lib.MsgConstCommon.LabexId.
|
inlinestatic |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. WARNING: searching for receiver element is done through an XPath expression, which may fail due to default namespaces that were not detected.
msg | Message in which receiver should be set. |
receiver | The new receiver of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new receiver has been written to the msg). |
|
inlinestatic |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false.
msg | Message document in which receiver should be set. |
receiver | The new receiver of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new receiver has been written to the msg). |
Referenced by LabexBis.Calypso.SendMessage().
|
inlinestatic |
Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false.
msg | Message in which receiver should be set. |
receiver | The new receiver of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new receiver has been written to the msg). |
References IG.Lib.XmlUtilityBase.LoadXml().
|
inlinestatic |
Sets the receiver of the communication msg stored in an Xml builder to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false.
data | XML builder containing the msg where receiver is to be set. |
receiver | The new receiver of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new receiver has been written to the msg). |
|
inlinestatic |
Sets the sender of the communication msg stored in an Xml builder to the specified sender, and indicates through an output argument whether the sender has been changed in msg. If the Sender stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false.
data | XML builder containing the msg where Sender is to be set. |
sender | The new Sender of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new Sender has been written to the msg). |
|
inlinestatic |
Sets the responder of the communication msg stored in an Xml builder to the specified responder, and indicates through an output argument whether the responder has been changed in msg. If the responder stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false.
data | XML builder containing the msg where responder is to be set. |
responder | The new responder of the msg. |
changed | Indicates whether the msg has been changed (i.e., whether the new responder has been written to the msg). |
|
inlinestaticprivate |
Returns true if data contains a msg of type MessageType.SpecimenObservationOrder.
data | XmlParser containing the msg. |
References IG.Lib.XmlParser.Current, IG.Lib.XmlParser.GoToRoot(), IG.Lib.XmlParser.Name, IG.Lib.XmlParser.NextOrCurrentElement(), and IG.Lib.XmlParser.StepIn().
|
inlinestaticprivate |
Returns true if data contains a msg of type MessageType.SpecimenObservationEvent.
data | XmlParser containing the msg. |
References IG.Lib.XmlParser.Current, IG.Lib.XmlParser.GoToRoot(), IG.Lib.XmlParser.Name, IG.Lib.XmlParser.NextOrCurrentElement(), and IG.Lib.XmlParser.StepIn().
|
inlinestaticprivate |
Returns true if data contains a msg of type MessageType.DetailedFinancialTransaction.
data | XmlParser containing the msg. |
References IG.Lib.XmlParser.Current, IG.Lib.XmlParser.GoToRoot(), IG.Lib.XmlParser.Name, IG.Lib.XmlParser.NextOrCurrentElement(), and IG.Lib.XmlParser.StepIn().
|
inlinestatic |
Infers the msg type from the XML string containing the msg, and returns it.
msgstring | Message string. |
Referenced by LabexBis.Calypso.GetMessage().
|
inlinestatic |
Infers the msg type from the XML document containing the msg, and returns it.
msg | Xml document containing the msg. |
References IG.Lib.XmlUtilityBase.LoadXml().
|
inlinestatic |
Infers the msg type from the XML parser containing the msg, and returns it.
msg | Xml parser containing the msg. |
MessageType IG.Lib.MsgBase.Type = MessageType.Unknown |
Message type. Helps with general methods that operate on any datatype of msg.
Referenced by IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), LabexBis.Calypso.SendOoNullifyToBis(), and IGTest.ProgramIGTest.TestCalypsoWs().
string IG.Lib.MsgBase.MessageId = null |
Message ID, obtained form the web service.
Referenced by LabexBis.Calypso.GetMessage(), IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), LabexBis.Calypso.SaveIncomingMessage(), LabexBis.Calypso.SendOoNullifyToBis(), and IGTest.ProgramIGTest.TestMsgObservationOrderNullifySend().
string IG.Lib.MsgBase.MessageFile = null |
Specifies the file where message has been backed up. Warning: this file may be deleted at any time!
Referenced by LabexBis.Calypso.GetMessage().
string IG.Lib.MsgBase.MessageNumber = null |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
staticprotected |
|
staticprivate |
|
staticgetprotected |
Gets objects that contains all constants related to communication messages.
|
getset |
Complete msg as obtained from the web service.
Referenced by LabexBis.Calypso.GetMessage(), IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), and LabexBis.Calypso.SaveIncomingMessage().