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()

Namespace: Nevatech.Vsb.Repository.Entities.Search

Assembly: Nevatech.Vsb.Repository.dll

Syntax

[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
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

[DataMember(EmitDefaultValue = false)]
public bool IncludeDescription { get; set; }

Property Value

Type	Description
bool

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

[DataMember(EmitDefaultValue = false)]
public bool? IsApprovalRequired { get; set; }

Property Value

Type	Description
bool?

IsPrivate

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

Declaration

[DataMember(EmitDefaultValue = false)]
public bool? IsPrivate { get; set; }

Property Value

Type	Description
bool?

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

[DataMember(EmitDefaultValue = false)]
public bool? IsSubscriptionRequired { get; set; }

Property Value

Type	Description
bool?

Key

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

Declaration

[DataMember(EmitDefaultValue = false)]
public Guid? Key { get; set; }

Property Value

Type	Description
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

[DataMember(EmitDefaultValue = false)]
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

[DataMember(EmitDefaultValue = false)]
public string Name { get; set; }

Property Value

Type	Description
string

SortField

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

Declaration

[DataMember]
public ProductsSortField SortField { get; set; }

Property Value

Type	Description
ProductsSortField

SortOrder

Gets or sets the result sort order.

Declaration

[DataMember]
public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder

Status

Gets or sets the product's life cycle status.

Declaration

[DataMember(EmitDefaultValue = false)]
public ProductStatus? Status { get; set; }

Property Value

Type	Description
ProductStatus?

Methods

Validate()

Evaluates the state of this object.

Declaration

public bool Validate()

Returns

Type	Description
bool	True if state is valid; otherwise, false.

Implements

IValidator