Class QueryParameter
Represents a query string parameter that needs to be set, replaced, or removed in an intercepted message.
Inheritance
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class QueryParameter : IValidator, IEquatable<QueryParameter>
Constructors
QueryParameter()
Declaration
public QueryParameter()
Fields
ElementName
Name of the root element when object is serialized to XML.
Declaration
public const string ElementName = "PARAMETER"
Field Value
Type | Description |
---|---|
System.String |
Properties
Action
Gets or sets the the action to take when a query parameter is already present in the message.
Declaration
public ExistingValueAction Action { get; set; }
Property Value
Type | Description |
---|---|
ExistingValueAction |
ErrorMessage
Gets the summary of validation errors populated by the call to Validate() method.
Declaration
public string ErrorMessage { get; }
Property Value
Type | Description |
---|---|
System.String |
Name
Gets or sets the query parameter's name. Name may contain a specially formatted context property name which value must be used as the query parameter name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Value
Gets or sets the new parameter value. Value may contain a specially formatted context property name which value must be used as the query parameter value. If set to Null, an existing parameter will be deleted.
Declaration
public string Value { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
Equals(QueryParameter)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(QueryParameter other)
Parameters
Type | Name | Description |
---|---|---|
QueryParameter | other | The object to compare with the current object. |
Returns
Type | Description |
---|---|
System.Boolean | True, if objects are equal. False, if objects 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 |
---|---|---|
System.Object | obj | The object to compare with the current object. |
Returns
Type | Description |
---|---|
System.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 |
---|---|
System.Int32 | Hash code of the current instance. |
Overrides
ToString()
Returns string representation of the object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String representing the object's content. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public bool Validate()
Returns
Type | Description |
---|---|
System.Boolean | True if state is valid; otherwise, false. |