Class: OneRosterClient::ResultType

Inherits:
BaseType
  • Object
show all
Defined in:
lib/oneroster_client/models/result_type.rb

Overview

…tbd (Class description)…

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResultType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
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
 
# File 'lib/oneroster_client/models/result_type.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OneRosterClient::ResultType` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OneRosterClient::ResultType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'line_item')
    self.line_item = attributes[:'line_item']
  end

  if attributes.key?(:'student')
    self.student = attributes[:'student']
  end

  if attributes.key?(:'score_status')
    self.score_status = attributes[:'score_status']
  end

  if attributes.key?(:'score')
    self.score = attributes[:'score']
  end

  if attributes.key?(:'score_date')
    self.score_date = attributes[:'score_date']
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.key?(:'sourced_id')
    self.sourced_id = attributes[:'sourced_id']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'date_last_modified')
    self.date_last_modified = attributes[:'date_last_modified']
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end
end

Instance Attribute Details

#comment ⇒ Object

Model Primitive Datatype = String



31
32
33
 
# File 'lib/oneroster_client/models/result_type.rb', line 31

def comment
  @comment
end

#date_last_modified ⇒ Object

Model Primitive Datatype = DateTime



39
40
41
 
# File 'lib/oneroster_client/models/result_type.rb', line 39

def date_last_modified
  @date_last_modified
end

#line_item ⇒ Object

Returns the value of attribute line_item.



18
19
20
 
# File 'lib/oneroster_client/models/result_type.rb', line 18

def line_item
  @line_item
end

#metadata ⇒ Object

…tbd (Class description)…



42
43
44
 
# File 'lib/oneroster_client/models/result_type.rb', line 42

def metadata
  @metadata
end

#score ⇒ Object

Model Primitive Datatype = Float



25
26
27
 
# File 'lib/oneroster_client/models/result_type.rb', line 25

def score
  @score
end

#score_date ⇒ Object

Model Primitive Datatype = Date



28
29
30
 
# File 'lib/oneroster_client/models/result_type.rb', line 28

def score_date
  @score_date
end

#score_status ⇒ Object

Returns the value of attribute score_status.



22
23
24
 
# File 'lib/oneroster_client/models/result_type.rb', line 22

def score_status
  @score_status
end

#sourced_id ⇒ Object

…tbd (Class description)…



34
35
36
 
# File 'lib/oneroster_client/models/result_type.rb', line 34

def sourced_id
  @sourced_id
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'lib/oneroster_client/models/result_type.rb', line 36

def status
  @status
end

#student ⇒ Object

Returns the value of attribute student.



20
21
22
 
# File 'lib/oneroster_client/models/result_type.rb', line 20

def student
  @student
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oneroster_client/models/result_type.rb', line 67

def self.attribute_map
  {
    :'line_item' => :'lineItem',
    :'student' => :'student',
    :'score_status' => :'scoreStatus',
    :'score' => :'score',
    :'score_date' => :'scoreDate',
    :'comment' => :'comment',
    :'sourced_id' => :'sourcedId',
    :'status' => :'status',
    :'date_last_modified' => :'dateLastModified',
    :'metadata' => :'metadata'
  }
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



272
273
274
 
# File 'lib/oneroster_client/models/result_type.rb', line 272

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/oneroster_client/models/result_type.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oneroster_client/models/result_type.rb', line 83

def self.openapi_types
  {
    :'line_item' => :'GUIDRefType',
    :'student' => :'GUIDRefType',
    :'score_status' => :'String',
    :'score' => :'Float',
    :'score_date' => :'DateTime',
    :'comment' => :'String',
    :'sourced_id' => :'String',
    :'status' => :'String',
    :'date_last_modified' => :'DateTime',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oneroster_client/models/result_type.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line_item == o.line_item &&
      student == o.student &&
      score_status == o.score_status &&
      score == o.score &&
      score_date == o.score_date &&
      comment == o.comment &&
      sourced_id == o.sourced_id &&
      status == o.status &&
      date_last_modified == o.date_last_modified &&
      metadata == o.metadata && super(o)
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



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
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oneroster_client/models/result_type.rb', line 303

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
    OneRosterClient.const_get(type).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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oneroster_client/models/result_type.rb', line 372

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oneroster_client/models/result_type.rb', line 279

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/oneroster_client/models/result_type.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/oneroster_client/models/result_type.rb', line 265

def hash
  [line_item, student, score_status, score, score_date, comment, sourced_id, status, date_last_modified, metadata].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



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
 
# File 'lib/oneroster_client/models/result_type.rb', line 165

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

  if @student.nil?
    invalid_properties.push('invalid value for "student", student cannot be nil.')
  end

  if @score_status.nil?
    invalid_properties.push('invalid value for "score_status", score_status cannot be nil.')
  end

  if @score.nil?
    invalid_properties.push('invalid value for "score", score cannot be nil.')
  end

  if @score_date.nil?
    invalid_properties.push('invalid value for "score_date", score_date cannot be nil.')
  end

  if @sourced_id.nil?
    invalid_properties.push('invalid value for "sourced_id", sourced_id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @date_last_modified.nil?
    invalid_properties.push('invalid value for "date_last_modified", date_last_modified cannot be nil.')
  end

  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



348
349
350
 
# File 'lib/oneroster_client/models/result_type.rb', line 348

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oneroster_client/models/result_type.rb', line 354

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



342
343
344
 
# File 'lib/oneroster_client/models/result_type.rb', line 342

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oneroster_client/models/result_type.rb', line 204

def valid?
  return false if @line_item.nil?
  return false if @student.nil?
  return false if @score_status.nil?
  score_status_validator = EnumAttributeValidator.new('', ['exempt', 'fully graded', 'not submmitted', 'partially graded', 'submitted'])
  return false unless score_status_validator.valid?(@score_status)
  return false if @score.nil?
  return false if @score_date.nil?
  return false if @sourced_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('', ['active', 'tobedeleted'])
  return false unless status_validator.valid?(@status)
  return false if @date_last_modified.nil?
  true
end