Class AbstractSearchCriteria

Inheritance
System.Object
AbstractSearchCriteria
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Search.Extensions
Assembly: Mediachase.Search.Extensions.dll
Version: 10.8.0
Syntax
public abstract class AbstractSearchCriteria : ISearchCriteria

Constructors

AbstractSearchCriteria()

Declaration
protected AbstractSearchCriteria()

Properties

ActiveFilterFields

Gets the active filter fields.

Declaration
public virtual string[] ActiveFilterFields { get; }
Property Value
Type Description
System.String[]

The active filter fields.

ActiveFilterValues

Gets the active filter values.

Declaration
public virtual ISearchFilterValue[] ActiveFilterValues { get; }
Property Value
Type Description
ISearchFilterValue[]

The active filter values.

CacheKey

Gets the cache key.

Declaration
public virtual string CacheKey { get; }
Property Value
Type Description
System.String

The cache key.

Currency

Gets or sets the currency.

Declaration
public virtual Currency Currency { get; set; }
Property Value
Type Description
Currency

The currency.

Filters

Gets the filters.

Declaration
public virtual 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
public virtual bool IgnoreFilterOnLanguage { get; set; }
Property Value
Type Description
System.Boolean

IncludeInactive

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

Declaration
public virtual bool IncludeInactive { get; set; }
Property Value
Type Description
System.Boolean

true if [include inactive]; otherwise, false.

IsModified

Gets a value indicating whether this instance is modified.

Declaration
protected bool IsModified { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is modified; otherwise, false.

KeyField

Gets the key field.

Declaration
public virtual string KeyField { get; }
Property Value
Type Description
System.String

The key field.

Locale

Gets or sets the locale.

Declaration
public virtual string Locale { get; set; }
Property Value
Type Description
System.String

The locale.

MarketId

Gets or set the market ID.

Declaration
public virtual MarketId MarketId { get; set; }
Property Value
Type Description
MarketId

The market ID.

RecordsToRetrieve

Gets or sets the records to retrieve.

Declaration
public virtual int RecordsToRetrieve { get; set; }
Property Value
Type Description
System.Int32

The records to retrieve.

Scope

Gets the scope.

Declaration
public abstract string Scope { get; }
Property Value
Type Description
System.String

The scope.

Sort

Gets the sorts.

Declaration
public virtual SearchSort Sort { get; set; }
Property Value
Type Description
SearchSort

The sorts.

StartingRecord

Gets or sets the starting record.

Declaration
public virtual int StartingRecord { get; set; }
Property Value
Type Description
System.Int32

The starting record.

Methods

Add(SearchFilter)

Adds the specified filter.

Declaration
public virtual void Add(SearchFilter filter)
Parameters
Type Name Description
SearchFilter filter

The filter.

Add(String, ISearchFilterValue)

Adds the specified filter.

Declaration
public void Add(string field, ISearchFilterValue value)
Parameters
Type Name Description
System.String field
ISearchFilterValue value

The value.

Add(String, IEnumerable<ISearchFilterValue>)

Adds the specified field.

Declaration
public void Add(string field, IEnumerable<ISearchFilterValue> value)
Parameters
Type Name Description
System.String field

The field.

System.Collections.Generic.IEnumerable<ISearchFilterValue> value

The value.

ChangeState()

Changes the state.

Declaration
protected virtual void ChangeState()

GetSelectedSearchFilterValues(String)

Gets the selected search filter values.

Declaration
public IEnumerable<ISearchFilterValue> GetSelectedSearchFilterValues(string fieldName)
Parameters
Type Name Description
System.String fieldName

Name of the field.

Returns
Type Description
System.Collections.Generic.IEnumerable<ISearchFilterValue>

Implements