Class: JSS::Criteriable::Criterion

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/jss/api_object/criteriable/criterion.rb,
lib/jss.rb

Overview

This class defines a single criterion used in advanced searches and smart groups throughout the JSS module.

They are used within Criteria instances which store an array of these objects and provides methods for working with them as a group.

The classes that mix-in JSS::Criteriable each have a :criteria attribute which holds one Criteria

See JSS::Criteriable for examples

Constant Summary collapse

SEARCH_TYPES =

These are the available search-types for building criteria

[
  'is',
  'is not',
  'like',
  'not like',
  'has',
  'does not have',
  'more than',
  'less than',
  'greater than',
  'less than',
  'greater than or equal',
  'less than or equal',
  'before (yyyy-mm-dd)',
  'after (yyyy-mm-dd)',
  'more than x days ago',
  'less than x days ago',
  'in more than x days',
  'in less than x days',
  'member of',
  'not member of',
  'current',
  'not current',
  'matches regex',
  'does not match regex'
].freeze
AND_OR =

the acceptable symboles for and/or

%i[and or].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Criterion

Note:

:priority is maintained by the JSS::Criteriable::Criteria object holding this instance

Returns a new instance of Criterion

Options Hash (args):

  • :and_or (String, Symbol)

    :and, or :or. How should this criterion be join with its predecessor?

  • :name (String)

    the name of a Criterion as is visible in the JSS webapp.

  • :search_type (String)

    one of SEARCH_TYPES, the comparison between the stored value and :value

  • :value (String)

    the value to compare with that stored for :name

Raises:


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/jss/api_object/criteriable/criterion.rb', line 126

def initialize(args = {})
  @priority = args[:priority]

  @and_or = (args[:and_or].downcase.to_sym if args[:and_or]) || :and
  raise JSS::InvalidDataError, ":and_or must be 'and' or 'or'." unless AND_OR.include? @and_or

  @name = args[:name]

  if args[:search_type]
    raise JSS::InvalidDataError, 'Invalid :search_type' unless SEARCH_TYPES.include? args[:search_type]
    @search_type = args[:search_type]
  end

  # from the API, parens come like this
  @opening_paren = args[:opening_paren]
  @closing_paren = args[:closing_paren]

  # but from a user, they might come as a single :paren key, which
  # will be handled by the setter below
  send 'paren=', args[:paren] if args.key? :paren

  # default to false
  @opening_paren ||= false
  @closing_paren ||= false

  @value = args[:value]
end

Instance Attribute Details

#and_orSymbol


100
101
102
# File 'lib/jss/api_object/criteriable/criterion.rb', line 100

def and_or
  @and_or
end

#closing_parenBoolean (readonly)


116
117
118
# File 'lib/jss/api_object/criteriable/criterion.rb', line 116

def closing_paren
  @closing_paren
end

#nameString


103
104
105
# File 'lib/jss/api_object/criteriable/criterion.rb', line 103

def name
  @name
end

#opening_parenBoolean (readonly)


113
114
115
# File 'lib/jss/api_object/criteriable/criterion.rb', line 113

def opening_paren
  @opening_paren
end

#priorityInteger


97
98
99
# File 'lib/jss/api_object/criteriable/criterion.rb', line 97

def priority
  @priority
end

#search_typeString

Returns the comparator between the field and the value, must be one of SEARCH_TYPES


107
108
109
# File 'lib/jss/api_object/criteriable/criterion.rb', line 107

def search_type
  @search_type
end

#valueString


110
111
112
# File 'lib/jss/api_object/criteriable/criterion.rb', line 110

def value
  @value
end

Instance Method Details

#<=>(other) ⇒ Integer

Comparison - allows the Comparable module to do its work

See Also:

  • Comparable

232
233
234
# File 'lib/jss/api_object/criteriable/criterion.rb', line 232

def <=>(other)
  signature <=> other.signature
end

#paren=(new_val) ⇒ void

This method returns an undefined value.

set the parenthesis for the criteria


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/jss/api_object/criteriable/criterion.rb', line 170

def paren=(new_val)
  case new_val
  when :opening
    @opening_paren = true
    @closing_paren = false
  when :closing
    @opening_paren = false
    @closing_paren = true
  when nil
    @opening_paren = false
    @closing_paren = false
  else
    raise JSS::InvalidDataError, 'paren must be :opening, :closing, or nil.'
  end
end

#rest_xmlREXML::Element

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

For this class, rest_xml can't be a private method.

Returns The xml element for the criterion, to be embeded in that of a Criteria instance


243
244
245
246
247
248
249
250
251
252
253
# File 'lib/jss/api_object/criteriable/criterion.rb', line 243

def rest_xml
  crn = REXML::Element.new 'criterion'
  crn.add_element('priority').text = @priority
  crn.add_element('and_or').text = @and_or
  crn.add_element('name').text = @name
  crn.add_element('search_type').text = @search_type
  crn.add_element('value').text = @value
  crn.add_element('opening_paren').text = @opening_paren ? 'true' : 'false'
  crn.add_element('closing_paren').text = @closing_paren ? 'true' : 'false'
  crn
end

#signatureString

Returns All our values except priority joined together for comparing this Criterion to another for equality and order

See Also:


222
223
224
# File 'lib/jss/api_object/criteriable/criterion.rb', line 222

def signature
  [@and_or, @name, @search_type, @value].join ','
end