Interface ISearchOptions

Inherited Members

ISearchDisplayFieldOptions.recordCountCallback

Namespace: Estrelica.Archer.Content

Assembly: Estrelica.Interfaces.dll

Syntax

public interface ISearchOptions : ISearchDisplayFieldOptions

Properties

expectedIds

Declaration

HashSet<int> expectedIds { get; set; }

Property Value

HashSet<int>

filterConditions

Declaration

IEnumerable<XElement> filterConditions { get; set; }

Property Value

IEnumerable<XElement>

filterContainedDisplayFields

Declaration

Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields { get; set; }

Property Value

Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>>

filterOperatorLogic

Declaration

string filterOperatorLogic { get; set; }

Property Value

string

includeFieldCallback

Declaration

Func<IArcherField, bool> includeFieldCallback { get; set; }

Property Value

Func<IArcherField, bool>

includeFieldIds

Declaration

IEnumerable<int> includeFieldIds { get; set; }

Property Value

IEnumerable<int>

includeXmlComments

Declaration

bool includeXmlComments { get; set; }

Property Value

bool

modifiedSince

Declaration

DateTime? modifiedSince { get; set; }

Property Value

DateTime?

pageSizeOverride

Declaration

int? pageSizeOverride { get; set; }

Property Value

int?

searchXmlPreview

Declaration

Action<string> searchXmlPreview { get; set; }

Property Value

Action<string>

sortFields

Declaration

IEnumerable<SortField> sortFields { get; set; }

Property Value

IEnumerable<SortField>

Methods

AddDisplayField(IArcherField)

Declaration

ISearchOptions AddDisplayField(IArcherField displayField)

Parameters

IArcherField displayField

Returns

ISearchOptions

AddDisplayField(int)

Declaration

ISearchOptions AddDisplayField(int displayFieldId)

Parameters

int displayFieldId

Returns

ISearchOptions

AddDisplayFields(params IArcherField[])

Declaration

ISearchOptions AddDisplayFields(params IArcherField[] displayFields)

Parameters

IArcherField[] displayFields

Returns

ISearchOptions

AddDisplayFields(IEnumerable<IArcherField>)

Declaration

ISearchOptions AddDisplayFields(IEnumerable<IArcherField> displayFields)

Parameters

IEnumerable<IArcherField> displayFields

Returns

ISearchOptions

AddDisplayFields(IEnumerable<int>)

Declaration

ISearchOptions AddDisplayFields(IEnumerable<int> displayFieldIds)

Parameters

IEnumerable<int> displayFieldIds

Returns

ISearchOptions

AddDisplayFields(params int[])

Declaration

ISearchOptions AddDisplayFields(params int[] displayFieldIds)

Parameters

int[] displayFieldIds

Returns

ISearchOptions

AddFilterCondition(XElement)

Declaration

ISearchOptions AddFilterCondition(XElement filterCondition)

Parameters

XElement filterCondition

Returns

ISearchOptions

AddFilterConditions(IEnumerable<XElement>)

Declaration

ISearchOptions AddFilterConditions(IEnumerable<XElement> filterConditions)

Parameters

IEnumerable<XElement> filterConditions

Returns

ISearchOptions

AddSortField(SortField)

Declaration

ISearchOptions AddSortField(SortField sortField)

Parameters

SortField sortField

Returns

ISearchOptions

AddSortField(IArcherField, SortType)

Declaration

ISearchOptions AddSortField(IArcherField sortField, SortType sortType = SortType.Ascending)

Parameters

IArcherField sortField

SortType sortType

Returns

ISearchOptions

AddSortField(int, SortType)

Declaration

ISearchOptions AddSortField(int sortFieldId, SortType sortType = SortType.Ascending)

Parameters

int sortFieldId

SortType sortType

Returns

ISearchOptions

ContainedDisplayFieldsFilter(Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>>)

Declaration

ISearchOptions ContainedDisplayFieldsFilter(Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields)

Parameters

Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields

Returns

ISearchOptions

FilterOperatorLogic(string)

Declaration

ISearchOptions FilterOperatorLogic(string filterOperatorLogic)

Parameters

string filterOperatorLogic

Returns

ISearchOptions

IncludeDisplayFieldCallback(Func<IArcherField, bool>)

Declaration

ISearchOptions IncludeDisplayFieldCallback(Func<IArcherField, bool> includeFieldCallback)

Parameters

Func<IArcherField, bool> includeFieldCallback

Returns

ISearchOptions

PageSize(int)

Declaration

ISearchOptions PageSize(int pageSizeOverride)

Parameters

int pageSizeOverride

Returns

ISearchOptions

RecordCountCallback(Action<RecordCountType, int>)

Declaration

ISearchOptions RecordCountCallback(Action<RecordCountType, int> recordCountCallback)

Parameters

Action<RecordCountType, int> recordCountCallback

Returns

ISearchOptions

SearchXmlPreview(Action<string>, bool)

Declaration

ISearchOptions SearchXmlPreview(Action<string> searchXmlPreview, bool includeXmlComments = false)

Parameters

Action<string> searchXmlPreview

bool includeXmlComments

Returns

ISearchOptions

Extension Methods

EnumHelper.In<TEnum>(TEnum, params TEnum[])

IEnumerableExtensions.ToEnumerable<T>(T)

StringExtensions.AssertNotNull<T>(T, string)

TypeExtensions.WithDispose<T, V>(T, Func<T, V>)

EnumHelper.CastNullable<TEnum>(object)

TypeExtensions.ConvertTo<V>(object)

TypeExtensions.TryConvert<V>(object, out V)