ssCore.Catalog.addRange

Define search criteria for a given field. This determines if the row should be included in the result set or not based on whether the field contents are between the specified low and high range values.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

fieldName - Name of the field you are defining the search criteria for.

lowValue - Low value for range.

highValue - High value for range.

matchType - [Optional] - Type of match desired. Use TXTRange to compare strings and NUMRange to perform numeric comparisons of the field contents against LowValue and HighValue. Valid values include: TXTRange,NUMRange. Default value is TXTRange.

exclusive - [Optional] - Set this to 'true' if the field must match the pattern. If you set this value to 'false', the row will be included if the pattern matches the field contents but it won't be excluded if it doesn't match. Valid values include: true,false. Default value is true.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Catalog.addRange( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Catalog.addRange( paramsObject );


Notes:

Case is always ignored when comparing the field contents with lowValue and highValue (for "TXTRANGE").

Catalog.addRange should be called as many times as necessary to define criteria for multiple fields. If you call it more than once for the same field, only the last setting will be used in the search.

                

Examples:

ssCore.Catalog.addRange({fieldName:"Projects", lowValue:10, highValue:20, matchType:"Partial", exclusive:true});