Difference between revisions of "Activity:AddSearchCriterion (Activity)"
(Created page with "{{ActivityInfoBox | title = Add Search Criterion | name = AddSearchCriterion | image = | imagecaption = Activity AddSearchCriterion | purpose = Adds a new search criterion to...") |
m (moved AddSearchCriterion to AddSearchCriterion (Activity)) |
(No difference)
| |
Revision as of 14:13, 7 January 2015
| Add Search Criterion | |
|---|---|
| Name | AddSearchCriterion |
| Purpose | Adds a new search criterion to a query |
| Category | Object Primitives |
| Returns | True if added successfully |
| Version | 2.1+ |
The AddSearchCriterion activity adds a new search criterion to a given query using the given parameters.
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| And | Boolean | In | If true, criteria are combined using AND (default); if false, criteria are combined using OR |
| Index | Integer | In | Property value index (indexed properties only required) |
| Operator | QuerySearchItemOperator | In | Search operator used |
| PropertyName | String | In | Name of property to search the value for |
| PropertyValue | T | In | Property value to be searched |
| Query | Query | In | Query instance |
| Result | Boolean | Out | True, if added successfully |
Usage
This activity adds a new search criterion to a given query using the parameters defined in the arguments. Once the query is evaluated the system searches for the value PropertyValue in the property PropertyName. For indexed properties an index can be defined as well. Multiple search criteria are either combined with AND / OR, depending on And argument.
