ServiceMessage¶
SAIF.Application.ServiceMessage carries the immutable key, message text, and message type used by service response objects.
Purpose¶
- Represent one categorized message returned to service callers.
- Support the result-object pattern centered on
ServiceResponse.
Context¶
- Namespace:
SAIF.Application - Assembly/package:
SAIF.BOF.Application
Public members¶
| Member | Signature | Purpose |
|---|---|---|
Key |
Public ReadOnly Property Key As String |
Expose the message key. |
Message |
Public ReadOnly Property Message As String |
Expose the message text. |
Type |
Public ReadOnly Property Type As ServiceMessageType |
Expose the message classification. |
New |
Public Sub New(ByVal inKey As String, ByVal inMessage As String, ByVal inType As ServiceMessageType) |
Create a service message from its key, text, and type. |
ToString |
Public Overrides Function ToString() As String |
Return the message text. |
Behavioral notes¶
- The type is used as the unit value stored and filtered by
ServiceResponse. - Message categorization is driven by
ServiceMessageTypevalues.
Constraints and usage notes¶
- The analysis describes the type as immutable; callers should create a new instance rather than mutate an existing one.
Sources¶
Application\SAIF.Application\Service Based\ServiceMessage.vb