Class ProductSearchQuery

Provides parameters for a query that selects products from the registry.

Inheritance

Object

ProductSearchQuery

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 ProductSearchQuery : IValidator

Constructors

ProductSearchQuery()

Declaration

public ProductSearchQuery()

Properties

ErrorMessage

Gets the message indicating the errors found during validation process.

Declaration

public string ErrorMessage { get; }

Property Value

Type	Description
String

IncludeDescription

Gets or sets the flag indicating that Description property needs to be populated in the result.

Declaration

public bool IncludeDescription { get; set; }

Property Value

Type	Description
Boolean

IsApprovalRequired

Gets or sets the flag indicating that consumers cannot subscribe and immediately start using the product without an explicit approval by Sentinet administrator.

Declaration

public bool? IsApprovalRequired { get; set; }

Property Value

Type	Description
Nullable<Boolean>

IsPrivate

Gets or sets the flag indicating that product should NOT be shown in the available products list.

Declaration

public bool? IsPrivate { get; set; }

Property Value

Type	Description
Nullable<Boolean>

IsSubscriptionRequired

Gets or sets the flag indicating that consumers must subscribe to the product and provide access keys when they call the product services.

Declaration

public bool? IsSubscriptionRequired { get; set; }

Property Value

Type	Description
Nullable<Boolean>

Key

Gets or sets the product 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>

Keywords

Gets or sets the semicolon-separated list of keywords or name/value tags that product must have. The keywords may include wildcards. Returned products must match all keywords and values in the list.

Declaration

public string Keywords { get; set; }

Property Value

Type	Description
String

Examples

soap;Weather*;1.0;version=1.0;owner=jsmith

Name

Gets or sets the searching entity friendly name that may include wildcards.

Declaration

public string Name { get; set; }

Property Value

Type	Description
String

SortField

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

Declaration

public ProductsSortField SortField { get; set; }

Property Value

Type	Description
ProductsSortField

SortOrder

Gets or sets the result sort order.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder

Status

Gets or sets the product's life cycle status.

Declaration

public ProductStatus? Status { get; set; }

Property Value

Type	Description
Nullable<ProductStatus>

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