Class MessageParameter

Defines a parameter of the request RESTful message. A unique parameter is defined by a combination of a name and location.

Inheritance
System.Object
Parameter
MessageParameter
Implements
System.IEquatable<Parameter>
System.Runtime.Serialization.IExtensibleDataObject
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class MessageParameter : Parameter, IValidator, IEquatable<Parameter>, IExtensibleDataObject

Constructors

MessageParameter()

Initializes an empty instance.

Declaration
public MessageParameter()

MessageParameter(MessageParameter)

Initializes new instance by copying properties from the provided message parameter.

Declaration
public MessageParameter(MessageParameter parameter)
Parameters
Type Name Description
MessageParameter parameter

Parameter to copy properties from.

Properties

Description

Gets or sets a brief description of the parameter. This could contain examples of use.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Location

Gets or sets the location of the parameter in the request message.

Declaration
public MessageParameterLocation Location { get; set; }
Property Value
Type Description
MessageParameterLocation

Name

Gets or sets the name of the parameter. If parameter location is Path, the name field MUST correspond to the associated path segment from the URI template. For all other cases, the name corresponds to the parameter name used based on the location.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

VariableName

Gets or sets the name of the variable to store the parameter value. The variable names must be unique in the message. The path and query parameters must match the URI template.

Declaration
public string VariableName { get; set; }
Property Value
Type Description
System.String

Methods

CopyFrom(Parameter)

Populates this instance from the provided parameter.

Declaration
public override void CopyFrom(Parameter parameter)
Parameters
Type Name Description
Parameter parameter

Parameter to copy properties from.
Overrides

Equals(Parameter)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(Parameter other)
Parameters
Type Name Description
Parameter 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.
Overrides

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 a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string that represents the current object.
Overrides

Validate()

Evaluates the state of this object.

Declaration
public override bool Validate()
Returns
Type Description
System.Boolean

True if state is valid; otherwise, false.
Overrides

Implements

System.IEquatable<T>
System.Runtime.Serialization.IExtensibleDataObject