Show / Hide Table of Contents

    Class ConditionComponent

    Implements a message pipeline component representing an IF statement with a condition represented by a AuthorizationExpressionBase expression.

    Inheritance
    Object
    MessagePipelineComponentBase
    ConditionComponent
    Implements
    IValidator
    IEquatable<MessagePipelineComponentBase>
    IExtensibleDataObject
    Inherited Members
    MessagePipelineComponentBase.AllowedPositions
    MessagePipelineComponentBase.ErrorMessage
    MessagePipelineComponentBase.ExtensionData
    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 ConditionComponent : MessagePipelineComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

    Constructors

    ConditionComponent()

    Declaration
    public ConditionComponent()

    Fields

    ElementName

    Name of the root element when object is serialized to XML.

    Declaration
    public const string ElementName = "CONDITION"
    Field Value
    Type Description
    String

    Properties

    Condition

    Gets or sets an expression to be evaluated. If expression returns True then TrueComponent is executed. If expression returns False then FalseComponent is executed.

    Declaration
    public AuthorizationExpressionBase Condition { get; set; }
    Property Value
    Type Description
    AuthorizationExpressionBase

    FalseComponent

    Gets or sets the message pipeline component to be executed if Condition evaluates to False (optional).

    Declaration
    public MessagePipelineComponentBase FalseComponent { get; set; }
    Property Value
    Type Description
    MessagePipelineComponentBase

    TrueComponent

    Gets or sets the message pipeline component to be executed if Condition evaluates to True.

    Declaration
    public MessagePipelineComponentBase TrueComponent { get; set; }
    Property Value
    Type Description
    MessagePipelineComponentBase

    Methods

    Equals(MessagePipelineComponentBase)

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

    Declaration
    public override bool Equals(MessagePipelineComponentBase other)
    Parameters
    Type Name Description
    MessagePipelineComponentBase other

    The object to compare with the current object.

    Returns
    Type Description
    Boolean

    True, if objects are equal. False, if objects are not equal.

    Overrides
    MessagePipelineComponentBase.Equals(MessagePipelineComponentBase)

    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
    MessagePipelineComponentBase.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
    MessagePipelineComponentBase.GetHashCode()

    ProcessMessage(MessagePipelineContext)

    Inspects the message and optionally modifies its content by calling either TrueComponent or FalseComponent.

    Declaration
    public override MessagePipelineResult ProcessMessage(MessagePipelineContext context)
    Parameters
    Type Name Description
    MessagePipelineContext context

    Provides the message processing context.

    Returns
    Type Description
    MessagePipelineResult

    Value indicating if message should continue on its way to the recipient or must be stopped and returned to the sender.

    Overrides
    MessagePipelineComponentBase.ProcessMessage(MessagePipelineContext)

    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 override bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    MessagePipelineComponentBase.Validate()

    Validate(MessagePipelinePositions)

    Evaluates the state of this component and ensures that component can operate at the provided message pipeline position.

    Declaration
    public override bool Validate(MessagePipelinePositions position)
    Parameters
    Type Name Description
    MessagePipelinePositions position

    Message pipeline position where component is intended to be used.

    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    MessagePipelineComponentBase.Validate(MessagePipelinePositions)

    Implements

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