Class SearchOptions

Implements operations for and represents the search options.

Inheritance

System.Object

SearchOptions

CatalogSearchOptions

ApplicationLogOptions

OrderSearchOptions

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.Commerce.Shared

Assembly: Mediachase.Commerce.dll

Version: 12.17.2

Syntax

public abstract class SearchOptions

Constructors

SearchOptions()

Initializes a new instance of the SearchOptions class.

Declaration

protected SearchOptions()

SearchOptions(SearchOptions)

Initializes a new instance of the SearchOptions class.

Declaration

protected SearchOptions(SearchOptions copy)

Parameters

Type	Name	Description
SearchOptions	copy	The copy.

Properties

CacheKey

Gets the cache key.

Declaration

public virtual string CacheKey { get; }

Property Value

Type	Description
System.String	The cache key.

CacheResults

Gets or sets a value indicating whether [cache results].

Declaration

public bool CacheResults { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [cache results]; otherwise, `false`.

CacheTimeout

Gets or sets the cache timeout.

Declaration

public TimeSpan CacheTimeout { get; set; }

Property Value

Type	Description
System.TimeSpan	The cache timeout.

Classes

Gets or sets the classes.

Declaration

public StringCollection Classes { get; set; }

Property Value

Type	Description
System.Collections.Specialized.StringCollection	The classes.

Namespace

Gets or sets the namespace.

Declaration

public string Namespace { get; set; }

Property Value

Type	Description
System.String	The namespace.

RecordsToRetrieve

Gets or sets the records to retrieve.

Declaration

public int RecordsToRetrieve { get; set; }

Property Value

Type	Description
System.Int32	The records to retrieve.

ReturnTotalCount

Gets or sets a value indicating whether [return total count].

Declaration

public bool ReturnTotalCount { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [return total count]; otherwise, `false`.

StartingRecord

Gets or sets the starting record.

Declaration

public int StartingRecord { get; set; }

Property Value

Type	Description
System.Int32	The starting record.