bajaScript

Class: OrdQueryList

baja. OrdQueryList

new OrdQueryList( [queries])

ORD Query List.

Used to hold a list of OrdQueries.

Parameters:
Name Type Argument Description
queries Array.<baja.OrdQuery> <optional>

an array of ORD queries.
See:

Extends

Methods

add(query)

Add an ORD Query to the List

Parameters:
Name Type Description
query baja.OrdQuery

equals(obj)

Indicates whether some other object is equal to this one.

Parameters:
Name Type Description
obj Object

the reference object with which to compare.
Inherited From:
Returns:

true if this object is the same as the obj argument; false otherwise.

Type
Boolean

get(index)

Return the query object at the specified index.

Parameters:
Name Type Description
index Number | String

or scheme name.
Returns:

query (or null if can't be found).

Type
baja.OrdQuery

getCursor()

Returns a Cursor for use with the ORD Query List.

Returns:
Type
module:baja/ord/OrdQueryListCursor

isClientResolvable()

Since:
  • Niagara 4.10
Returns:

false if this list contains an ORD scheme that cannot be
resolved in the client

Type
boolean

isEmpty()

Is the list empty?

Returns:
Type
Boolean

isSameScheme(indexA, indexB)

Parameters:
Name Type Description
indexA number
indexB number
Since:
  • Niagara 4.10
Returns:

true if the queries at both indexes exist and are the
same scheme

Type
boolean

merge(index, query)

Deletes the queries at the given index and the one after, then inserts the
given query in their place.

Parameters:
Name Type Description
index number
query baja.OrdQuery
Since:
  • Niagara 4.10

remove(index)

Remove the entry at the specified index and return it.

Parameters:
Name Type Description
index Number
Returns:

query

Type
baja.OrdQuery

set(index, query)

Set an ORD query object at the given index.

Parameters:
Name Type Description
index Number
query baja.OrdQuery

size()

Return the size of the query list.

Returns:

size of the list.

Type
Number

toString( [length])

Return String representation of the ORD Query List.

Parameters:
Name Type Argument Default Description
length Number <optional>
 size()

number of queries to include in the string
Returns:
Type
String

valueOf()

Return the inner value of the object.

By default the object's instance is returned.

Inherited From:
Returns:

the inner value of the object or just the object's instance.

Type
*