Class: Alfresco::SearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco/models/search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/alfresco/models/search_request.rb', line 114

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'query')
    self.query = attributes[:'query']
  end

  if attributes.has_key?(:'paging')
    self.paging = attributes[:'paging']
  end

  if attributes.has_key?(:'include')
    self.include = attributes[:'include']
  end

  if attributes.has_key?(:'includeRequest')
    self.include_request = attributes[:'includeRequest']
  else
    self.include_request = false
  end

  if attributes.has_key?(:'fields')
    self.fields = attributes[:'fields']
  end

  if attributes.has_key?(:'sort')
    self.sort = attributes[:'sort']
  end

  if attributes.has_key?(:'templates')
    self.templates = attributes[:'templates']
  end

  if attributes.has_key?(:'defaults')
    self.defaults = attributes[:'defaults']
  end

  if attributes.has_key?(:'localization')
    self.localization = attributes[:'localization']
  end

  if attributes.has_key?(:'filterQueries')
    self.filter_queries = attributes[:'filterQueries']
  end

  if attributes.has_key?(:'facetQueries')
    self.facet_queries = attributes[:'facetQueries']
  end

  if attributes.has_key?(:'facetFields')
    self.facet_fields = attributes[:'facetFields']
  end

  if attributes.has_key?(:'facetIntervals')
    self.facet_intervals = attributes[:'facetIntervals']
  end

  if attributes.has_key?(:'pivots')
    if (value = attributes[:'pivots']).is_a?(Array)
      self.pivots = value
    end
  end

  if attributes.has_key?(:'stats')
    if (value = attributes[:'stats']).is_a?(Array)
      self.stats = value
    end
  end

  if attributes.has_key?(:'spellcheck')
    self.spellcheck = attributes[:'spellcheck']
  end

  if attributes.has_key?(:'scope')
    self.scope = attributes[:'scope']
  end

  if attributes.has_key?(:'limits')
    self.limits = attributes[:'limits']
  end

  if attributes.has_key?(:'highlight')
    self.highlight = attributes[:'highlight']
  end

  if attributes.has_key?(:'ranges')
    if (value = attributes[:'ranges']).is_a?(Array)
      self.ranges = value
    end
  end

end

Instance Attribute Details

#defaults ⇒ Object

Returns the value of attribute defaults.



33
34
35
 
# File 'lib/alfresco/models/search_request.rb', line 33

def defaults
  @defaults
end

#facet_fields ⇒ Object

Returns the value of attribute facet_fields.



41
42
43
 
# File 'lib/alfresco/models/search_request.rb', line 41

def facet_fields
  @facet_fields
end

#facet_intervals ⇒ Object

Returns the value of attribute facet_intervals.



43
44
45
 
# File 'lib/alfresco/models/search_request.rb', line 43

def facet_intervals
  @facet_intervals
end

#facet_queries ⇒ Object

Returns the value of attribute facet_queries.



39
40
41
 
# File 'lib/alfresco/models/search_request.rb', line 39

def facet_queries
  @facet_queries
end

#fields ⇒ Object

Returns the value of attribute fields.



27
28
29
 
# File 'lib/alfresco/models/search_request.rb', line 27

def fields
  @fields
end

#filter_queries ⇒ Object

Returns the value of attribute filter_queries.



37
38
39
 
# File 'lib/alfresco/models/search_request.rb', line 37

def filter_queries
  @filter_queries
end

#highlight ⇒ Object

Returns the value of attribute highlight.



55
56
57
 
# File 'lib/alfresco/models/search_request.rb', line 55

def highlight
  @highlight
end

#include ⇒ Object

Returns the value of attribute include.



22
23
24
 
# File 'lib/alfresco/models/search_request.rb', line 22

def include
  @include
end

#include_request ⇒ Object

When true, include the original request in the response



25
26
27
 
# File 'lib/alfresco/models/search_request.rb', line 25

def include_request
  @include_request
end

#limits ⇒ Object

Returns the value of attribute limits.



53
54
55
 
# File 'lib/alfresco/models/search_request.rb', line 53

def limits
  @limits
end

#localization ⇒ Object

Returns the value of attribute localization.



35
36
37
 
# File 'lib/alfresco/models/search_request.rb', line 35

def localization
  @localization
end

#paging ⇒ Object

Returns the value of attribute paging.



20
21
22
 
# File 'lib/alfresco/models/search_request.rb', line 20

def paging
  @paging
end

#pivots ⇒ Object

Returns the value of attribute pivots.



45
46
47
 
# File 'lib/alfresco/models/search_request.rb', line 45

def pivots
  @pivots
end

#query ⇒ Object

Returns the value of attribute query.



18
19
20
 
# File 'lib/alfresco/models/search_request.rb', line 18

def query
  @query
end

#ranges ⇒ Object

Returns the value of attribute ranges.



57
58
59
 
# File 'lib/alfresco/models/search_request.rb', line 57

def ranges
  @ranges
end

#scope ⇒ Object

Returns the value of attribute scope.



51
52
53
 
# File 'lib/alfresco/models/search_request.rb', line 51

def scope
  @scope
end

#sort ⇒ Object

Returns the value of attribute sort.



29
30
31
 
# File 'lib/alfresco/models/search_request.rb', line 29

def sort
  @sort
end

#spellcheck ⇒ Object

Returns the value of attribute spellcheck.



49
50
51
 
# File 'lib/alfresco/models/search_request.rb', line 49

def spellcheck
  @spellcheck
end

#stats ⇒ Object

Returns the value of attribute stats.



47
48
49
 
# File 'lib/alfresco/models/search_request.rb', line 47

def stats
  @stats
end

#templates ⇒ Object

Returns the value of attribute templates.



31
32
33
 
# File 'lib/alfresco/models/search_request.rb', line 31

def templates
  @templates
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/alfresco/models/search_request.rb', line 61

def self.attribute_map
  {
    :'query' => :'query',
    :'paging' => :'paging',
    :'include' => :'include',
    :'include_request' => :'includeRequest',
    :'fields' => :'fields',
    :'sort' => :'sort',
    :'templates' => :'templates',
    :'defaults' => :'defaults',
    :'localization' => :'localization',
    :'filter_queries' => :'filterQueries',
    :'facet_queries' => :'facetQueries',
    :'facet_fields' => :'facetFields',
    :'facet_intervals' => :'facetIntervals',
    :'pivots' => :'pivots',
    :'stats' => :'stats',
    :'spellcheck' => :'spellcheck',
    :'scope' => :'scope',
    :'limits' => :'limits',
    :'highlight' => :'highlight',
    :'ranges' => :'ranges'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/alfresco/models/search_request.rb', line 87

def self.swagger_types
  {
    :'query' => :'RequestQuery',
    :'paging' => :'RequestPagination',
    :'include' => :'RequestInclude',
    :'include_request' => :'BOOLEAN',
    :'fields' => :'RequestFields',
    :'sort' => :'RequestSortDefinition',
    :'templates' => :'RequestTemplates',
    :'defaults' => :'RequestDefaults',
    :'localization' => :'RequestLocalization',
    :'filter_queries' => :'RequestFilterQueries',
    :'facet_queries' => :'RequestFacetQueries',
    :'facet_fields' => :'RequestFacetFields',
    :'facet_intervals' => :'RequestFacetIntervals',
    :'pivots' => :'Array<RequestPivot>',
    :'stats' => :'Array<RequestStats>',
    :'spellcheck' => :'RequestSpellcheck',
    :'scope' => :'RequestScope',
    :'limits' => :'RequestLimits',
    :'highlight' => :'RequestHighlight',
    :'ranges' => :'Array<RequestRange>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/alfresco/models/search_request.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      paging == o.paging &&
      include == o.include &&
      include_request == o.include_request &&
      fields == o.fields &&
      sort == o.sort &&
      templates == o.templates &&
      defaults == o.defaults &&
      localization == o.localization &&
      filter_queries == o.filter_queries &&
      facet_queries == o.facet_queries &&
      facet_fields == o.facet_fields &&
      facet_intervals == o.facet_intervals &&
      pivots == o.pivots &&
      stats == o.stats &&
      spellcheck == o.spellcheck &&
      scope == o.scope &&
      limits == o.limits &&
      highlight == o.highlight &&
      ranges == o.ranges
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/alfresco/models/search_request.rb', line 291

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Alfresco.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/alfresco/models/search_request.rb', line 357

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/alfresco/models/search_request.rb', line 270

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/alfresco/models/search_request.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/alfresco/models/search_request.rb', line 263

def hash
  [query, paging, include, include_request, fields, sort, templates, defaults, localization, filter_queries, facet_queries, facet_fields, facet_intervals, pivots, stats, spellcheck, scope, limits, highlight, ranges].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



212
213
214
215
216
217
218
219
 
# File 'lib/alfresco/models/search_request.rb', line 212

def list_invalid_properties
  invalid_properties = Array.new
  if @query.nil?
    invalid_properties.push("invalid value for 'query', query cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
 
# File 'lib/alfresco/models/search_request.rb', line 337

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
 
# File 'lib/alfresco/models/search_request.rb', line 343

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



331
332
333
 
# File 'lib/alfresco/models/search_request.rb', line 331

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



223
224
225
226
 
# File 'lib/alfresco/models/search_request.rb', line 223

def valid?
  return false if @query.nil?
  return true
end