new OrdQueryList(queriesopt)
- Description:
ORD Query List.
Used to hold a list of OrdQueries.
- Source:
- See:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
queries |
Array.<baja.OrdQuery> |
<optional> |
an array of ORD queries. |
Extends
Methods
add(query)
- Description:
Add an ORD Query to the List
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
query |
baja.OrdQuery |
equals(obj) → {Boolean}
- Description:
Indicates whether some other object is equal to this one.
- Source:
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object | the reference object with which to compare. |
Returns:
true if this object is the same as the obj argument; false otherwise.
- Type
- Boolean
get(index) → {baja.OrdQuery}
- Description:
Return the query object at the specified index.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Number | String | or scheme name. |
Returns:
query (or null if can't be found).
- Type
- baja.OrdQuery
getCursor() → {module:baja/ord/OrdQueryListCursor}
- Description:
Returns a Cursor for use with the ORD Query List.
- Source:
Returns:
isClientResolvable() → {boolean}
- Source:
- Since:
- Niagara 4.10
Returns:
false if this list contains an ORD scheme that cannot be
resolved in the client
- Type
- boolean
isEmpty() → {Boolean}
- Description:
Is the list empty?
- Source:
Returns:
- Type
- Boolean
isSameScheme(indexA, indexB) → {boolean}
- Source:
- Since:
- Niagara 4.10
Parameters:
| Name | Type | Description |
|---|---|---|
indexA |
number | |
indexB |
number |
Returns:
true if the queries at both indexes exist and are the
same scheme
- Type
- boolean
merge(index, query)
- Description:
Deletes the queries at the given index and the one after, then inserts the
given query in their place.
- Source:
- Since:
- Niagara 4.10
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | |
query |
baja.OrdQuery |
remove(index) → {baja.OrdQuery}
- Description:
Remove the entry at the specified index and return it.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Number |
Returns:
query
- Type
- baja.OrdQuery
set(index, query)
- Description:
Set an ORD query object at the given index.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Number | |
query |
baja.OrdQuery |
size() → {Number}
- Description:
Return the size of the query list.
- Source:
Returns:
size of the list.
- Type
- Number
toString(lengthopt) → {String}
- Description:
Return String representation of the ORD Query List.
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
length |
Number |
<optional> |
size()
|
number of queries to include in the string |
Returns:
- Type
- String
valueOf() → {*}
- Description:
Return the inner value of the object.
By default the object's instance is returned.
- Source:
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *