Class: NucleusApi::Question

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/question.rb

Overview

Question Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Question

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
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
 
# File 'lib/nucleus_api/models/question.rb', line 109

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?(:'answers')
    if (value = attributes[:'answers']).is_a?(Array)
      self.answers = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#answers ⇒ Object

Returns the value of attribute answers.



18
19
20
 
# File 'lib/nucleus_api/models/question.rb', line 18

def answers
  @answers
end

#category ⇒ Object

category



21
22
23
 
# File 'lib/nucleus_api/models/question.rb', line 21

def category
  @category
end

#description ⇒ Object

description



24
25
26
 
# File 'lib/nucleus_api/models/question.rb', line 24

def description
  @description
end

#document ⇒ Object

document



27
28
29
 
# File 'lib/nucleus_api/models/question.rb', line 27

def document
  @document
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/nucleus_api/models/question.rb', line 29

def id
  @id
end

#image ⇒ Object

image



32
33
34
 
# File 'lib/nucleus_api/models/question.rb', line 32

def image
  @image
end

#is_account ⇒ Object

is_account



35
36
37
 
# File 'lib/nucleus_api/models/question.rb', line 35

def 
  
end

#metadata ⇒ Object

metadata



38
39
40
 
# File 'lib/nucleus_api/models/question.rb', line 38

def metadata
  @metadata
end

#order_index ⇒ Object

order_index



41
42
43
 
# File 'lib/nucleus_api/models/question.rb', line 41

def order_index
  @order_index
end

#question_type ⇒ Object

question_type



44
45
46
 
# File 'lib/nucleus_api/models/question.rb', line 44

def question_type
  @question_type
end

#questionnaire ⇒ Object

Returns the value of attribute questionnaire.



46
47
48
 
# File 'lib/nucleus_api/models/question.rb', line 46

def questionnaire
  @questionnaire
end

#questionnaire_id ⇒ Object

questionnaireId



49
50
51
 
# File 'lib/nucleus_api/models/question.rb', line 49

def questionnaire_id
  @questionnaire_id
end

#subcategory ⇒ Object

subcategory



52
53
54
 
# File 'lib/nucleus_api/models/question.rb', line 52

def subcategory
  @subcategory
end

#title ⇒ Object

title



55
56
57
 
# File 'lib/nucleus_api/models/question.rb', line 55

def title
  @title
end

#tooltip ⇒ Object

tooltip



58
59
60
 
# File 'lib/nucleus_api/models/question.rb', line 58

def tooltip
  @tooltip
end

#weight ⇒ Object

weight



61
62
63
 
# File 'lib/nucleus_api/models/question.rb', line 61

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/nucleus_api/models/question.rb', line 64

def self.attribute_map
  {
    :'answers' => :'answers',
    :'category' => :'category',
    :'description' => :'description',
    :'document' => :'document',
    :'id' => :'id',
    :'image' => :'image',
    :'is_account' => :'is_account',
    :'metadata' => :'metadata',
    :'order_index' => :'order_index',
    :'question_type' => :'question_type',
    :'questionnaire' => :'questionnaire',
    :'questionnaire_id' => :'questionnaire_id',
    :'subcategory' => :'subcategory',
    :'title' => :'title',
    :'tooltip' => :'tooltip',
    :'weight' => :'weight'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/nucleus_api/models/question.rb', line 86

def self.swagger_types
  {
    :'answers' => :'Array<Answer>',
    :'category' => :'String',
    :'description' => :'String',
    :'document' => :'String',
    :'id' => :'String',
    :'image' => :'String',
    :'is_account' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'order_index' => :'String',
    :'question_type' => :'String',
    :'questionnaire' => :'Questionnaire',
    :'questionnaire_id' => :'String',
    :'subcategory' => :'String',
    :'title' => :'String',
    :'tooltip' => :'String',
    :'weight' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/nucleus_api/models/question.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      answers == o.answers &&
      category == o.category &&
      description == o.description &&
      document == o.document &&
      id == o.id &&
      image == o.image &&
       == o. &&
      metadata == o.metadata &&
      order_index == o.order_index &&
      question_type == o.question_type &&
      questionnaire == o.questionnaire &&
      questionnaire_id == o.questionnaire_id &&
      subcategory == o.subcategory &&
      title == o.title &&
      tooltip == o.tooltip &&
      weight == o.weight
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/nucleus_api/models/question.rb', line 255

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = NucleusApi.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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/nucleus_api/models/question.rb', line 319

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/nucleus_api/models/question.rb', line 235

def build_from_hash(attributes)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


222
223
224
 
# File 'lib/nucleus_api/models/question.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/nucleus_api/models/question.rb', line 228

def hash
  [answers, category, description, document, id, image, , metadata, order_index, question_type, questionnaire, questionnaire_id, subcategory, title, tooltip, weight].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



186
187
188
189
 
# File 'lib/nucleus_api/models/question.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  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



300
301
302
 
# File 'lib/nucleus_api/models/question.rb', line 300

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



306
307
308
309
310
311
312
313
 
# File 'lib/nucleus_api/models/question.rb', line 306

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

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



294
295
296
 
# File 'lib/nucleus_api/models/question.rb', line 294

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



193
194
195
 
# File 'lib/nucleus_api/models/question.rb', line 193

def valid?
  true
end