Object. SearchColumn is a simple utility object used to hold a name and value. It may also holds an operator value which is used in some cases to represent the relationship between the name and value (e.g.: a search operator.)
The SearchColumn object is used to specify:
See also: InputParameters.searchColumns, InputParameters.sortColumns, Calling Lasso Substitution Tags
The SearchColumn object has the following properties:
|
Property |
Description |
|---|---|
| name | The property used to hold the name. |
| value | The property used to hold the value. |
| operator | The numeric operator property. |
The SearchColumn object has the following methods:
|
Property |
Description |
|---|---|
| constructor | The method used to construct a SearchColumn object. |
Property. A String object used to hold a name.
See the constructor examples provided below.
Property. A String object used to hold a value.
See the constructor examples provided below.
Property. A number used to hold an operator. Valid operators include:
See the constructor examples provided below.
Method. The constructor for SearchColumn can take the name, value and operator as optional arguments.
The following statements are all valid.
var sf1 = new SearchColumn( "Name", "Value", theOp ); var sf2 = new SearchColumn( "Name", "Value" ); var sf3 = new SearchColumn();
Example 1. This example will create a new LassoSession object and add a search field to the input parameters.
var mySession = new LassoSession(); var myInput = mySession.getInputParameters(); var currField = new SearchColumn(); currField.name = "TheFieldName"; currField.value = "TheFieldValue"; currField.operator = lasso.opEquals; myInput.searchColumns.push( currField );
Example 2. This example will create a new LassoSession object and add a sort field to the input parameters.
var mySession = new LassoSession();
var myInput = mySession.getInputParameters();
var currField = new SearchColumn("SortThisField", "ascending");
myInput.sortColumns.push( currField );