VideoOS.Platform.Search.SearchCriteria Class Reference

Data class containing all search criteria data (i.e. values of selected SearchFilters) which is to be used in the SearchDefinition it belongs to. More...

Public Member Functions
void	AddFilterValue (SearchFilter searchFilter)
	Adds a filter value for the given search filter by invoking SearchFilter.CreateValue.
void	AddFilterValue (SearchFilter searchFilter, FilterValueBase filterValue)
	Adds a filter value for the given search filter./>.
void	ClearFilterValues (SearchFilter searchFilter)
	Clears all search filter values for the provided search filter.
ReadOnlyCollection< FilterValueBase >	GetFilterValues (SearchFilter searchFilter)
	Gets the value(s) of the given filter. Use this when invoking your search to obtain the filter values setup by the user.
ReadOnlyCollection< FilterValueBase >	GetFilterValues (SearchFilter searchFilter, bool removeEmptyValues)
	Gets the value(s) of the given filter. This overload provides an option to keep/remove empty values. This is needed by the UI to be able to show a filter value even though it is "empty".
ReadOnlyCollection< T >	GetFilterValues< T > (SearchFilter searchFilter)
	Gets the value(s) of the given filter as the provided generic type. Use this when invoking your search to obtain the filter values setup by the user.
void	RemoveFilterValue (SearchFilter searchFilter, FilterValueBase filterValue)
	Removes the provided search filter value from the search criteria.
	SearchCriteria (SearchScope searchScope)
	Constructor taking the search scope as parameter.

Events
EventHandler< SearchCriteriaChangedEventArgs >	Changed
	Indication that the search criteria has changed.

Detailed Description

Data class containing all search criteria data (i.e. values of selected SearchFilters) which is to be used in the SearchDefinition it belongs to.

Constructor & Destructor Documentation

SearchCriteria()

VideoOS.Platform.Search.SearchCriteria.SearchCriteria ( SearchScope searchScope )

inline

Constructor taking the search scope as parameter.

Parameters

searchScope

The search scope associated with the search criteria.

Member Function Documentation

AddFilterValue() [1/2]

void VideoOS.Platform.Search.SearchCriteria.AddFilterValue ( SearchFilter searchFilter )

inline

Adds a filter value for the given search filter by invoking SearchFilter.CreateValue.

Parameters

searchFilter

The search filter for which to add a search filter value.

AddFilterValue() [2/2]

void VideoOS.Platform.Search.SearchCriteria.AddFilterValue ( SearchFilter searchFilter, FilterValueBase filterValue )

inline

Adds a filter value for the given search filter./>.

Parameters

searchFilter	The search filter for which to add a search filter value.
filterValue	The filter value to add.

ClearFilterValues()

void VideoOS.Platform.Search.SearchCriteria.ClearFilterValues ( SearchFilter searchFilter )

inline

Clears all search filter values for the provided search filter.

Parameters

searchFilter

The search filter for which to clear all values.

GetFilterValues() [1/2]

ReadOnlyCollection< FilterValueBase > VideoOS.Platform.Search.SearchCriteria.GetFilterValues ( SearchFilter searchFilter )

inline

Gets the value(s) of the given filter. Use this when invoking your search to obtain the filter values setup by the user.

Parameters

searchFilter

The filter to get the value(s) for.

Returns

The value(s) of the given search filter.

GetFilterValues() [2/2]

ReadOnlyCollection< FilterValueBase > VideoOS.Platform.Search.SearchCriteria.GetFilterValues ( SearchFilter searchFilter, bool removeEmptyValues )

inline

Gets the value(s) of the given filter. This overload provides an option to keep/remove empty values. This is needed by the UI to be able to show a filter value even though it is "empty".

NOTE: You should not call this method from your search agent, this is a method intended for a UI application.

Parameters

searchFilter	The filter to get the value(s) for.
removeEmptyValues	Specifies whether to include/exclude empty values in the result.

Returns

The value(s) of the given search filter.

GetFilterValues< T >()

ReadOnlyCollection< T > VideoOS.Platform.Search.SearchCriteria.GetFilterValues< T > ( SearchFilter searchFilter )

inline

Gets the value(s) of the given filter as the provided generic type. Use this when invoking your search to obtain the filter values setup by the user.

Template Parameters

T	The type of filter values to return a collection of.

Parameters

searchFilter

The filter to get the value for.

Returns

The value(s) of the given search filter as the provided generic type.

RemoveFilterValue()

void VideoOS.Platform.Search.SearchCriteria.RemoveFilterValue ( SearchFilter searchFilter, FilterValueBase filterValue )

inline

Removes the provided search filter value from the search criteria.

Parameters

searchFilter	The search filter which the filterValue was previously added to.
filterValue	The search filter value to remove.

Event Documentation

Changed

EventHandler<SearchCriteriaChangedEventArgs> VideoOS.Platform.Search.SearchCriteria.Changed

Indication that the search criteria has changed.