Class Message
Represents a message description which is a part of service operation.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public class Message : DomainObjectBase, IValidator, IExtensibleDataObject, IEquatable<Message>
Constructors
Message()
Initializes a new instance of the Message object.
Declaration
public Message()
Properties
Action
Gets or sets message Action header. Action can be empty, but cannot be null for SOAP services.
Declaration
public string Action { get; set; }
Property Value
Type | Description |
---|---|
String |
BodyProtectionLevel
Gets or sets message body protection requirements.
Declaration
public ProtectionLevel? BodyProtectionLevel { get; set; }
Property Value
Type | Description |
---|---|
Nullable<ProtectionLevel> |
Direction
Gets or sets message type and direction.
Declaration
public MessageDirection Direction { get; set; }
Property Value
Type | Description |
---|---|
MessageDirection |
DownstreamMessageId
Gets or sets identifier of the message that needs to be send to physical service. This property is populated for virtual services only.
Declaration
public int? DownstreamMessageId { get; set; }
Property Value
Type | Description |
---|---|
Nullable<Int32> |
IsSecured
Gets flag indicating that message requires secured binding.
Declaration
public bool IsSecured { get; }
Property Value
Type | Description |
---|---|
Boolean |
Name
Gets or sets the message element name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Namespace
Gets or sets the message element namespace.
Declaration
public string Namespace { get; set; }
Property Value
Type | Description |
---|---|
String |
ObjectType
Gets object type identifier.
Declaration
public override EntityType ObjectType { get; }
Property Value
Type | Description |
---|---|
EntityType |
Overrides
OperationId
Gets or sets operation identifier this message is part of.
Declaration
public int OperationId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
QName
Gets the XML qualified name of the message element.
Declaration
public XmlQualifiedName QName { get; }
Property Value
Type | Description |
---|---|
XmlQualifiedName |
Settings
Gets the message configuration settings.
Declaration
public MessageSettings Settings { get; }
Property Value
Type | Description |
---|---|
MessageSettings |
TemplateFileId
Gets or sets the identifier of the file storing the template message content.
Declaration
public int? TemplateFileId { get; set; }
Property Value
Type | Description |
---|---|
Nullable<Int32> |
TemplateMessageVersion
Gets or sets the message envelope version of the template message stored in a file.
Declaration
public MessageEnvelopeVersion TemplateMessageVersion { get; set; }
Property Value
Type | Description |
---|---|
MessageEnvelopeVersion |
Methods
Equals(Message)
Determines whether the specified message is equal to the current message.
Declaration
public bool Equals(Message other)
Parameters
Type | Name | Description |
---|---|---|
Message | other | The message to compare with the current message. |
Returns
Type | Description |
---|---|
Boolean | True, if messages are equal. False, if messages are not equal. |
Equals(Object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | The object to compare with the current object. |
Returns
Type | Description |
---|---|
Boolean | True, if objects are equal. False, if objects are not equal. |
Overrides
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 | Hash code of the current instance. |
Overrides
IsMatch(Message, Message)
Returns flag indicating that provided instances represent the same entity, i.e. the object's natural keys are the same. This method assumes that both instances are assigned to the same parent object.
Declaration
public static bool IsMatch(Message message1, Message message2)
Parameters
Type | Name | Description |
---|---|---|
Message | message1 | First instance to be compared. |
Message | message2 | Second instance to be compared. |
Returns
Type | Description |
---|---|
Boolean | True, if provided instances represent the same entity. False, otherwise. |
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | A string that represents the current object. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public override bool Validate()
Returns
Type | Description |
---|---|
Boolean | True if state is valid; otherwise, false. |