Class: OData::Query::Criteria

Inherits:

Object

• Object
• OData::Query::Criteria

Defined in:

lib/odata/query/criteria.rb

Overview

Represents a discreet detail about an OData query. It also validates the criteria based on what the gem knows how to support.

Constant Summary

REQUIRED_OPTIONS =

Defines the options required to create a new OData::Query::Criteria.

[:operation, :argument]

SUPPORTED_OPERATIONS =

Defines the operations the OData gem knows how to support.

[
  :filter, :order_by, :skip, :top, :select, :expand, :inline_count
]

Instance Method Summary

• #argument ⇒ String

  The query argument of a particular criteria.

• #initialize(options = {}) ⇒ Criteria constructor

  Creates a new OData::Query::Criteria with the supplied options.

• #operation ⇒ Symbol

  The query operation of a particular criteria.

Constructor Details

#initialize(options = {}) ⇒ Criteria

Creates a new OData::Query::Criteria with the supplied options.

Parameters:

• options (Hash) (defaults to: {})

# File 'lib/odata/query/criteria.rb', line 16

def initialize(options = {})
  @options = process_options(options)
  validate_required_options
  validate_supported_operation
end

Instance Method Details

#argument ⇒ String

The query argument of a particular criteria.

Returns:

• (String)

# File 'lib/odata/query/criteria.rb', line 30

def argument
  options[:argument]
end

#operation ⇒ Symbol

The query operation of a particular criteria.

Returns:

• (Symbol)

# File 'lib/odata/query/criteria.rb', line 24

def operation
  options[:operation]
end