docs

Classes

Expand

Defines children to expand.

Expansion

Defines a child to expand.

Eq

Specifies a filter condition where two values are equivalent.

Ge

Specifies a filter condition where the left operand if greater than or equal to the right.

Gt

Specifies a filter condition where the left operand if greater than the right.

Has

Specifies a filter condition where the left operand is an enumeration of the right operand.

In

Specifies a filter condition where the left operand is a value in the right operand.

Le

Specifies a filter condition where the left operand if less than or equal to the right.

Lt

Specifies a filter condition where the left operand if less than the right.

Ne

Specifies a filter condition where two values are not equivalent.

RelationalFilter

Filters results with a relational condition between two values.

Order

Defines a sort order for a specific piece of criteria.

OrderBy

Defines criteria to order by.

Select

Specifies the fields to select.

QueryOptions

Defines the options of a query.

Query

Defines an OData query.

StringUtils

Provides additional functionality for strings.

Expand

Defines children to expand.

Kind: global class

• Expand
  • new Expand(expansions)
  • .toString() ⇒ string

new Expand(expansions)

Creates an Expand.

Param	Description
expansions	The children expansion definitions.

expand.toString() ⇒ string

Outputs the OData parameter string.

Kind: instance method of Expand
Returns: string -

The resulting parameter string.

Expansion

Defines a child to expand.

Kind: global class

• Expansion
  • new Expansion(field, query)
  • .toString() ⇒ string

new Expansion(field, query)

Creates an Expansion.

Param	Description
field	The child field to expand.
query	The query to apply to the child.

expansion.toString() ⇒ string

Outputs the OData parameter string.

Kind: instance method of Expansion
Returns: string -

The resulting parameter string.

Eq

Specifies a filter condition where two values are equivalent.

Kind: global class

new Eq(left, right)

Creates an Eq.

Param	Description
left	The left operand.
right	The right operand.

Ge

Specifies a filter condition where the left operand if greater than or equal to the right.

Kind: global class

new Ge(left, right)

Creates an Ge.

Param	Description
left	The left operand.
right	The right operand.

Gt

Specifies a filter condition where the left operand if greater than the right.

Kind: global class

new Gt(left, right)

Creates an Gt.

Param	Description
left	The left operand.
right	The right operand.

Has

Specifies a filter condition where the left operand is an enumeration of the right operand.

Kind: global class

new Has(left, right)

Creates a Has.

Param	Description
left	The left operand.
right	The right operand.

In

Specifies a filter condition where the left operand is a value in the right operand.

Kind: global class

new In(left, right)

Creates an In.

Param	Description
left	The left operand.
right	The right operand.

Le

Specifies a filter condition where the left operand if less than or equal to the right.

Kind: global class

new Le(left, right)

Creates an Le.

Param	Description
left	The left operand.
right	The right operand.

Lt

Specifies a filter condition where the left operand if less than the right.

Kind: global class

new Lt(left, right)

Creates an Lt.

Param	Description
left	The left operand.
right	The right operand.

Ne

Specifies a filter condition where two values are not equivalent.

Kind: global class

new Ne(left, right)

Creates an Ne.

Param	Description
left	The left operand.
right	The right operand.

RelationalFilter

Filters results with a relational condition between two values.

Kind: global class

• RelationalFilter
  • new RelationalFilter(operator, left, right)
  • .toString(prefix)

new RelationalFilter(operator, left, right)

Creates a RelationalFilter.

Param	Description
operator	The operator to compare the values with.
left	The left operand.
right	The right operand.

relationalFilter.toString(prefix)

Outputs the OData parameter string.

Kind: instance method of RelationalFilter

Param	Description
prefix	The prefix to use in the parameter string.

Order

Defines a sort order for a specific piece of criteria.

Kind: global class

• Order
  • new Order(criteria, ascending)
  • .toString() ⇒ string

new Order(criteria, ascending)

Creates an Order.

Param	Default	Description
criteria		The criteria to order by.
ascending	true	The direction to sort.

order.toString() ⇒ string

Outputs the OData parameter string.

Kind: instance method of Order
Returns: string -

The resulting parameter string.

OrderBy

Defines criteria to order by.

Kind: global class

• OrderBy
  • new OrderBy(orders)
  • .toString() ⇒ string

new OrderBy(orders)

Creates an OrderBy.

Param	Description
orders	The criteria to order by.

orderBy.toString() ⇒ string

Outputs the OData parameter string.

Kind: instance method of OrderBy
Returns: string -

The resulting parameter string.

Select

Specifies the fields to select.

Kind: global class

• Select
  • new Select(fields)
  • .toString() ⇒ string

new Select(fields)

Creates a Select.

Param	Description
fields	The fields to select.

select.toString() ⇒ string

Outputs the OData parameter string.

Kind: instance method of Select
Returns: string -

The resulting parameter string.

QueryOptions

Defines the options of a query.

Kind: global class

Query

Defines an OData query.

Kind: global class

• Query
  • new Query(options)
  • .toString(deliminator) ⇒ string

new Query(options)

Creates a Query.

Param	Description
options	The options to apply to the query.

query.toString(deliminator) ⇒ string

Converts the Query as an OData query string.

Kind: instance method of Query
Returns: string -

The resulting query string.

Param	Default	Description
deliminator	&	The deliminator to use between parameter strings.

StringUtils

Provides additional functionality for strings.

Kind: global class

StringUtils.isEmptyOrWhitespace(str)

Checks if a string is empty or whitespace.

Kind: static method of StringUtils

Param	Description
str	The string to check.