Class ComplexSearchCriteria<T>

A structure for defining criteria which represent a reference type.

Inheritance
Object
ComplexSearchCriteria<T>
AuthorSearchFilter
FileSearchFilter
LocationSearchFilter
ProjectSearchFilter
TaxonomySearchFilter
Inherited Members
Namespace: Unity.Cloud.Assets
Syntax
public abstract class ComplexSearchCriteria<T> : ISearchCriteria
Type Parameters
Name Description
T

Properties

SearchFieldType

Declaration
public virtual Type SearchFieldType { get; }
Property Value
Type Description
Type
Implements

SearchKey

Declaration
public abstract string SearchKey { get; }
Property Value
Type Description
String
Implements

Methods

BuildSearchKeyPrefix()

Declaration
protected virtual string BuildSearchKeyPrefix()
Returns
Type Description
String

Clear()

Implement this method to clear the criteria fields.

Declaration
public void Clear()
Implements

Exclude(T)

Declaration
public virtual void Exclude(T value)
Parameters
Type Name Description
T value

ForAny(T)

Declaration
public virtual void ForAny(T value)
Parameters
Type Name Description
T value

Include(T)

Declaration
public virtual void Include(T value)
Parameters
Type Name Description
T value

IsAny(Object)

Declaration
protected virtual bool IsAny(object input)
Parameters
Type Name Description
Object input
Returns
Type Description
Boolean

IsMatch(Object)

Declaration
protected virtual bool IsMatch(object input)
Parameters
Type Name Description
Object input
Returns
Type Description
Boolean

Explicit Interface Implementations

ISearchCriteria.Exclude(Dictionary<String, Object>, String)

Implement this method to add the included value to the collection of excludedValues.

Declaration
void ISearchCriteria.Exclude(Dictionary<string, object> excludedValues, string prefix)
Parameters
Type Name Description
Dictionary<String, Object> excludedValues

The collection in which to add a value to exclude from the search.

String prefix

A prefix for the SearchKey; may be empty.

Implements

ISearchCriteria.Exclude(Object)

Implement this method to explicitly exclude results presenting the value in a search.

Declaration
void ISearchCriteria.Exclude(object value)
Parameters
Type Name Description
Object value

A value to exclude from a search.

Implements

ISearchCriteria.ForAny(Dictionary<String, Object>, String)

Implement this method to add the included value to the collection of forAnyValues.

Declaration
void ISearchCriteria.ForAny(Dictionary<string, object> forAnyValues, string prefix)
Parameters
Type Name Description
Dictionary<String, Object> forAnyValues

The collection in which to add an optional value for the search.

String prefix

A prefix for the SearchKey; may be empty.

Implements

ISearchCriteria.ForAny(Object)

Implement this method to include results presenting the value in a search.

Declaration
void ISearchCriteria.ForAny(object value)
Parameters
Type Name Description
Object value

An optional value for a search.

Implements

ISearchCriteria.Include(Dictionary<String, Object>, String)

Implement this method to add the included value to the collection of includedValues.

Declaration
void ISearchCriteria.Include(Dictionary<string, object> includedValues, string prefix)
Parameters
Type Name Description
Dictionary<String, Object> includedValues

The collection in which to add a value to include in the search.

String prefix

A prefix for the SearchKey; may be empty.

Implements

ISearchCriteria.Include(Object)

Implement this method to explicitly include results presenting the value in a search.

Declaration
void ISearchCriteria.Include(object value)
Parameters
Type Name Description
Object value

A required value for a search.

Implements

ISearchCriteria.IsAny(Object)

Implement this method to verify whether the input satisfies the optional search critiera.

Declaration
bool ISearchCriteria.IsAny(object input)
Parameters
Type Name Description
Object input

The element to compare to the criteria.

Returns
Type Description
Boolean

True if the input satisfies the criteria, false otherwise.

Implements

ISearchCriteria.IsEmpty()

Implement this method to return whether the criteria has been populated.

Declaration
bool ISearchCriteria.IsEmpty()
Returns
Type Description
Boolean

True if there are no requirements to meet, false otherwise.

Implements

ISearchCriteria.IsMatch(Object)

Implement this method to verify whether an input satisfies the search criteria.

Declaration
bool ISearchCriteria.IsMatch(object input)
Parameters
Type Name Description
Object input

The element to compare to the criteria.

Returns
Type Description
Boolean

True if the input satisfies the criteria, false otherwise.

Implements

ISearchCriteria.TryGetAny(out Object)

Implement this method to return the included search element.

Declaration
bool ISearchCriteria.TryGetAny(out object anyValue)
Parameters
Type Name Description
Object anyValue

The optional search value.

Returns
Type Description
Boolean

True if the criteria should be included in the search, false otherwise.

Implements

ISearchCriteria.TryGetExcluded(out Object)

Implement this method to return the included search element.

Declaration
bool ISearchCriteria.TryGetExcluded(out object excludedValue)
Parameters
Type Name Description
Object excludedValue

The excluded search value.

Returns
Type Description
Boolean

True if the criteria should be included in the search, false otherwise.

Implements

ISearchCriteria.TryGetIncluded(out Object)

Implement this method to return the included search element.

Declaration
bool ISearchCriteria.TryGetIncluded(out object includedValue)
Parameters
Type Name Description
Object includedValue

The included search value.

Returns
Type Description
Boolean

True if the criteria should be included in the search, false otherwise.

Implements