Class: OneRosterClient::ClassType

Inherits:
BaseType
  • Object
show all
Defined in:
lib/oneroster_client/models/class_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 = {}) ⇒ ClassType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oneroster_client/models/class_type.rb', line 134

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OneRosterClient::ClassType` 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::ClassType`. 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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

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

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

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

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

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

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

#class_code ⇒ Object

Model Primitive Datatype = NormalizedString



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

def class_code
  @class_code
end

#class_type ⇒ Object

Returns the value of attribute class_type.



24
25
26
 
# File 'lib/oneroster_client/models/class_type.rb', line 24

def class_type
  @class_type
end

#course ⇒ Object

Returns the value of attribute course.



35
36
37
 
# File 'lib/oneroster_client/models/class_type.rb', line 35

def course
  @course
end

#date_last_modified ⇒ Object

Model Primitive Datatype = DateTime



55
56
57
 
# File 'lib/oneroster_client/models/class_type.rb', line 55

def date_last_modified
  @date_last_modified
end

#grades ⇒ Object

Model Primitive Datatype = NormalizedString



30
31
32
 
# File 'lib/oneroster_client/models/class_type.rb', line 30

def grades
  @grades
end

#location ⇒ Object

Model Primitive Datatype = NormalizedString



27
28
29
 
# File 'lib/oneroster_client/models/class_type.rb', line 27

def location
  @location
end

#metadata ⇒ Object

…tbd (Class description)…



58
59
60
 
# File 'lib/oneroster_client/models/class_type.rb', line 58

def metadata
  @metadata
end

#periods ⇒ Object

Model Primitive Datatype = NormalizedString



45
46
47
 
# File 'lib/oneroster_client/models/class_type.rb', line 45

def periods
  @periods
end

#resources ⇒ Object

Returns the value of attribute resources.



47
48
49
 
# File 'lib/oneroster_client/models/class_type.rb', line 47

def resources
  @resources
end

#school ⇒ Object

Returns the value of attribute school.



37
38
39
 
# File 'lib/oneroster_client/models/class_type.rb', line 37

def school
  @school
end

#sourced_id ⇒ Object

…tbd (Class description)…



50
51
52
 
# File 'lib/oneroster_client/models/class_type.rb', line 50

def sourced_id
  @sourced_id
end

#status ⇒ Object

Returns the value of attribute status.



52
53
54
 
# File 'lib/oneroster_client/models/class_type.rb', line 52

def status
  @status
end

#subject_codes ⇒ Object

Model Primitive Datatype = NormalizedString



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

def subject_codes
  @subject_codes
end

#subjects ⇒ Object

Model Primitive Datatype = NormalizedString



33
34
35
 
# File 'lib/oneroster_client/models/class_type.rb', line 33

def subjects
  @subjects
end

#terms ⇒ Object

Returns the value of attribute terms.



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

def terms
  @terms
end

#title ⇒ Object

Model Primitive Datatype = NormalizedString



19
20
21
 
# File 'lib/oneroster_client/models/class_type.rb', line 19

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oneroster_client/models/class_type.rb', line 83

def self.attribute_map
  {
    :'title' => :'title',
    :'class_code' => :'classCode',
    :'class_type' => :'classType',
    :'location' => :'location',
    :'grades' => :'grades',
    :'subjects' => :'subjects',
    :'course' => :'course',
    :'school' => :'school',
    :'terms' => :'terms',
    :'subject_codes' => :'subjectCodes',
    :'periods' => :'periods',
    :'resources' => :'resources',
    :'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



325
326
327
 
# File 'lib/oneroster_client/models/class_type.rb', line 325

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/oneroster_client/models/class_type.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oneroster_client/models/class_type.rb', line 105

def self.openapi_types
  {
    :'title' => :'String',
    :'class_code' => :'String',
    :'class_type' => :'String',
    :'location' => :'String',
    :'grades' => :'Array<String>',
    :'subjects' => :'Array<String>',
    :'course' => :'GUIDRefType',
    :'school' => :'GUIDRefType',
    :'terms' => :'Array<GUIDRefType>',
    :'subject_codes' => :'Array<String>',
    :'periods' => :'Array<String>',
    :'resources' => :'Array<GUIDRefType>',
    :'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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oneroster_client/models/class_type.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      class_code == o.class_code &&
      class_type == o.class_type &&
      location == o.location &&
      grades == o.grades &&
      subjects == o.subjects &&
      course == o.course &&
      school == o.school &&
      terms == o.terms &&
      subject_codes == o.subject_codes &&
      periods == o.periods &&
      resources == o.resources &&
      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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oneroster_client/models/class_type.rb', line 356

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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/oneroster_client/models/class_type.rb', line 425

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oneroster_client/models/class_type.rb', line 332

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


312
313
314
 
# File 'lib/oneroster_client/models/class_type.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



318
319
320
 
# File 'lib/oneroster_client/models/class_type.rb', line 318

def hash
  [title, class_code, class_type, location, grades, subjects, course, school, terms, subject_codes, periods, resources, 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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oneroster_client/models/class_type.rb', line 227

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

  if @school.nil?
    invalid_properties.push('invalid value for "school", school 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



401
402
403
 
# File 'lib/oneroster_client/models/class_type.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oneroster_client/models/class_type.rb', line 407

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



395
396
397
 
# File 'lib/oneroster_client/models/class_type.rb', line 395

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



254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oneroster_client/models/class_type.rb', line 254

def valid?
  return false if @title.nil?
  class_type_validator = EnumAttributeValidator.new('', ['homeroom', 'scheduled'])
  return false unless class_type_validator.valid?(@class_type)
  return false if @school.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