Interface ISearchCriteria

Namespace: Mediachase.Search

Assembly: Mediachase.Search.dll

Version: 12.17.2

Syntax

public interface ISearchCriteria

Properties

ActiveFilterFields

Gets the active filter fields.

Declaration

string[] ActiveFilterFields { get; }

Property Value

Type	Description
System.String[]	The active filter fields.

ActiveFilterValues

Gets the active filter values.

Declaration

ISearchFilterValue[] ActiveFilterValues { get; }

Property Value

Type	Description
ISearchFilterValue[]	The active filter values.

CacheKey

Gets the cache key.

Declaration

string CacheKey { get; }

Property Value

Type	Description
System.String	The cache key.

Currency

Gets or sets the currency.

Declaration

Currency Currency { get; set; }

Property Value

Type	Description
Currency	The currency.

Filters

Gets the filters.

Declaration

SearchFilter[] Filters { get; }

Property Value

Type	Description
SearchFilter[]	The filters.

IgnoreFilterOnLanguage

Specifies if the search should filter on Locale or seach on all languages.

Declaration

bool IgnoreFilterOnLanguage { get; set; }

Property Value

Type	Description
System.Boolean

IncludeInactive

Gets or sets a value indicating whether include inactive entries in results.

Declaration

bool IncludeInactive { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [include inactive]; otherwise, `false`.

KeyField

Gets the key field.

Declaration

string KeyField { get; }

Property Value

Type	Description
System.String	The key field.

Locale

Gets or sets the locale.

Declaration

string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

MarketId

Gets or set the market ID.

Declaration

MarketId MarketId { get; set; }

Property Value

Type	Description
MarketId	The market ID.

RecordsToRetrieve

Gets or sets the records to retrieve.

Declaration

int RecordsToRetrieve { get; set; }

Property Value

Type	Description
System.Int32	The records to retrieve.

Scope

Gets the scope.

Declaration

string Scope { get; }

Property Value

Type	Description
System.String	The scope.

Sort

Gets the sorts.

Declaration

SearchSort Sort { get; set; }

Property Value

Type	Description
SearchSort	The sorts.

StartingRecord

Gets or sets the starting record.

Declaration

int StartingRecord { get; set; }

Property Value

Type	Description
System.Int32	The starting record.

Methods

Add(SearchFilter)

Adds the specified filter.

Declaration

void Add(SearchFilter filter)

Parameters

Type	Name	Description
SearchFilter	filter	The filter.

Add(String, ISearchFilterValue)

Adds the specified filter.

Declaration

void Add(string field, ISearchFilterValue value)

Parameters

Type	Name	Description
System.String	field	The field.
ISearchFilterValue	value	The value.