Show / Hide Table of Contents

    Class SubscriptionSearchQuery

    Provides parameters for a query that selects product subscriptions from the registry.

    Inheritance
    Object
    SubscriptionSearchQuery
    Implements
    IValidator
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Entities.Search
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public sealed class SubscriptionSearchQuery : IValidator

    Constructors

    SubscriptionSearchQuery()

    Declaration
    public SubscriptionSearchQuery()

    Properties

    ConsumerId

    Gets or sets the identifier of the consumer account that subscription belongs to. If identifier is provided then ConsumerName search parameter is ignored.

    Declaration
    public int? ConsumerId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    ConsumerName

    Gets or sets the name of the consumer account that subscription belongs to.

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

    CreatedFrom

    Gets or sets the earliest subscription creation date and time.

    Declaration
    public DateTime? CreatedFrom { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    CreatedTo

    Gets or sets the latest subscription creation date and time.

    Declaration
    public DateTime? CreatedTo { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    ErrorMessage

    Gets the message indicating the errors found during validation process.

    Declaration
    public string ErrorMessage { get; }
    Property Value
    Type Description
    String

    ExpirationFrom

    Gets or sets the earliest subscription expiration date and time (UTC).

    Declaration
    public DateTime? ExpirationFrom { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    ExpirationTo

    Gets or sets the latest subscription expiration date and time (UTC).

    Declaration
    public DateTime? ExpirationTo { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    Key

    Gets or sets the product subscription unique identifier. If key is provided then all other search parameters are ignored.

    Declaration
    public Guid? Key { get; set; }
    Property Value
    Type Description
    Nullable<Guid>

    Name

    Gets or sets the display name of the subscription.

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

    ProductId

    Gets or sets the identifier of the product included in the subscription. If identifier is provided then ProductName search parameter is ignored.

    Declaration
    public int? ProductId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    ProductName

    Gets or sets the product name included in the subscription.

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

    SortField

    Gets or sets the field that result will be sorted by.

    Declaration
    public SubscriptionsSortField SortField { get; set; }
    Property Value
    Type Description
    SubscriptionsSortField

    SortOrder

    Gets or sets the result sort order.

    Declaration
    public SortOrder SortOrder { get; set; }
    Property Value
    Type Description
    SortOrder

    Status

    Gets or sets the current status of the subscription.

    Declaration
    public SubscriptionStatus? Status { get; set; }
    Property Value
    Type Description
    Nullable<SubscriptionStatus>

    Methods

    Validate()

    Evaluates the state of this object.

    Declaration
    public bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Implements

    IValidator
    Back to top Nevatech Sentinet 6.5 Online Documentation