Design Pattern Framework 3.5
ResponseBase Class
Patterns-In-Action! Application ► ActionService.MessageBase ► ResponseBase
Base class for all response messages to clients of the web service. It standardizes
communication between web services and clients with a series of common values and
their initial defaults. Derived response message classes can override the default
values if necessary.
Declaration Syntax| C# | Visual Basic |
public class ResponseBase
Public Class ResponseBase
Members| All Members | Constructors | Methods | Fields | ||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
ResponseBase()()() |
Initializes a new instance of the ResponseBase class
|
|
Acknowledge |
A flag indicating success or failure of the web service response back to the
client. Default is success. Ebay.com uses this model.
|
|
|
Build |
Build number of currently executing web service. Used as an indicator
to client whether certain code fixes are included or not.
Ebay.com uses this in their API.
|
|
|
CorrelationId |
CorrelationId mostly returns the RequestId back to client.
|
|
|
Equals(Object) | (Inherited from Object.) |
|
Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
|
|
GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
|
GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
|
|
MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
|
|
Message |
Message back to client. Mostly used when a web service failure occurs.
|
|
|
ReservationExpires |
Date when reservation number expires.
|
|
|
ReservationId |
Reservation number issued by the web service. Used in long running requests.
Also sometimes referred to as Correlation Id. This number is a way for both the client
and web service to keep track of long running requests (for example, a request
to make a reservation for a airplane flight).
|
|
|
RowsAffected |
Number of rows affected by "Create", "Update", or "Delete" action.
|
|
|
ToString()()() | (Inherited from Object.) |
|
|
Version |
Version number (in major.minor format) of currently executing web service.
Used to offer a level of understanding (related to compatibility issues) between
the client and the web service as the web services evolve over time.
Ebay.com uses this in their API.
|
Inheritance Hierarchy
