Show / Hide Table of Contents

    Class QueryParameter

    Represents a query string parameter that needs to be set, replaced, or removed in an intercepted message.

    Inheritance
    Object
    QueryParameter
    Implements
    IValidator
    IEquatable<QueryParameter>
    Inherited Members
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    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
    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
    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
    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
    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
    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
    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
    Object.Equals(Object)

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code of the current instance.

    Overrides
    Object.GetHashCode()

    ToString()

    Returns string representation of the object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    String representing the object's content.

    Overrides
    Object.ToString()

    Validate()

    Evaluates the state of this object.

    Declaration
    public bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Implements

    IValidator
    System.IEquatable<T>
    Back to top Nevatech Sentinet 6.5 Online Documentation