cacheManagerName | String Name of the cache manager that manages the cache. This parameter is case sensitive. | |
cacheName | String Name of the cache from which the search results are to be returned. This parameter is case sensitive. | |
includeAttributes | String Optional. List of attributes that should be included in the search results. | |
includeKey | String Optional. Indicates whether or not the keys should be returned as part of the search results. true indicates that the keys should be returned as part of the search results. false indicates that the keys should not be returned as part of the search results. This is the default. Note: You should set this parameter to true only if the value is required for your programming logic. | |
includeValue | String Optional. Indicates whether or not the values should be returned as part of the search results. true indicates that the values should be returned as part of the search results. false indicates that the values should not be returned as part of the search results. This is the default. Note: You should set this parameter to true only if the value is required for your programming logic. | |
criteria | Document A document (IData) that specifies the conditions based on which the data in the cache is to be queried. | |
Value | Description | |
OP1 | String or Document A string operand or a nested document type that can be evaluated by a logical operator. | |
OPR | String A logical (and, or, and not) or comparison operator (between, gt (greater than), eq (equal to), and so on). For a complete list of operators that Integration Server supports as the value for the criteria\OPR parameter, see the Usage Notes for this service. | |
OP2 | String, Document, Object, or Object List A string operand, nested document type, object, or object list that can be evaluated by a logical operator. | |
maxResults | String Optional. The maximum number of results to return. If maxResults is not specified, Integration Server returns all the results. | |
groupBy | String List Optional. The unique values of specified attributes based on which the search results are to be grouped. The attributes that you specify for grouping the results must be included in the list of attributes specified for the includeAttributes parameter. | |
orderBy | String Table Optional. Whether the service results are to be returned in ascending or descending order. Values for this parameter must be specified as a two-dimensional string array comprising the field name and whether DESCENDING or ASCENDING (case sensitive) in the following format: {{"fieldName","order"},{"fieldName","order"}} Where order is ASCENDING or DESCENDING. For example, if you have configured name and age as the search attributes for the personCache cache that stores name, age, and address, the orderBy parameter can be specified as shown below: {{"name","ASCENDING"}} -or- {{"name","ASCENDING"},{"age","DESCENDING"}} | |
aggregator | String Table Aggregator function such as average, count, max, min, or sum that you want to be applied on the search results. Values for this parameter should be specified as a two-dimensional string array in the following format: {{"fieldName","aggregator"}, {"fieldName","aggregator"}} Where aggregator can be average, count, max, min, or sum (case-insensitive). For example, {{"age","Max"}} or {{"income","Average"}}. If you want to use the aggregator function, you must: Specify a value for the groupBy parameter. Set the includeKey and includeValue parameters to false. |
result | Object List The returned results of the search. Each object in the result parameter is of type com.wm.app.b2b.client.cache.config.SearchResult. For more information about com.wm.app.b2b.client.cache.config.SearchResult type, see webMethods Integration Server Java API Reference. Each object contains information about the cache element, key, value, search attribute values, and aggregator results, if any. |
Operators | Description |
and | AND logical operator |
between | Comparison between two values. |
eq | Equals |
gt | Greater than |
ge | Greater than or equal to |
ilike | Regular expression matcher using '?' and "*". |
in | Comparison operator meaning in the collection given as an argument. |
isNull | Checks whether the value of an attribute is null. |
lt | Less than. |
le | Less than or equal to |
not | NOT logical operator |
ne | Not equal to |
notNull | Checks whether the value of an attribute with given name is NOT null. |
or | OR logical operator |