Interface ISearchCriteria
Implement this interface to manage a type of criteria for searches.
Namespace: Unity.Cloud.Assets
Syntax
public interface ISearchCriteriaProperties
SearchFieldType
Implement this property to return the type of the search element.
Declaration
Type SearchFieldType { get; }Property Value
| Type | Description |
|---|---|
| Type |
SearchKey
Implement this property to return the key of the search element.
Declaration
string SearchKey { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
Clear()
Implement this method to clear the criteria fields.
Declaration
void Clear()Exclude(Dictionary<String, Object>, String)
Implement this method to add the included value to the collection of excludedValues.
Declaration
void 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. |
Exclude(Object)
Implement this method to explicitly exclude results presenting the value in a search.
Declaration
void Exclude(object value)Parameters
| Type | Name | Description |
|---|---|---|
| Object | value | A value to exclude from a search. |
ForAny(Dictionary<String, Object>, String)
Implement this method to add the included value to the collection of forAnyValues.
Declaration
void 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. |
ForAny(Object)
Implement this method to include results presenting the value in a search.
Declaration
void ForAny(object value)Parameters
| Type | Name | Description |
|---|---|---|
| Object | value | An optional value for a search. |
Include(Dictionary<String, Object>, String)
Implement this method to add the included value to the collection of includedValues.
Declaration
void 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. |
Include(Object)
Implement this method to explicitly include results presenting the value in a search.
Declaration
void Include(object value)Parameters
| Type | Name | Description |
|---|---|---|
| Object | value | A required value for a search. |
IsAny(Object)
Implement this method to verify whether the input satisfies the optional search critiera.
Declaration
bool IsAny(object input)Parameters
| Type | Name | Description |
|---|---|---|
| Object | input | The element to compare to the criteria. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the |
IsEmpty()
Implement this method to return whether the criteria has been populated.
Declaration
bool IsEmpty()Returns
| Type | Description |
|---|---|
| Boolean | True if there are no requirements to meet, false otherwise. |
IsMatch(Object)
Implement this method to verify whether an input satisfies the search criteria.
Declaration
bool IsMatch(object input)Parameters
| Type | Name | Description |
|---|---|---|
| Object | input | The element to compare to the criteria. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the |
TryGetAny(out Object)
Implement this method to return the included search element.
Declaration
bool 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. |
TryGetExcluded(out Object)
Implement this method to return the included search element.
Declaration
bool 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. |
TryGetIncluded(out Object)
Implement this method to return the included search element.
Declaration
bool 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. |