Class: OneRosterClient::CourseType

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'course_code')
    self.course_code = attributes[:'course_code']
  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?(:'org')
    self.org = attributes[:'org']
  end

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

#course_code ⇒ Object

Model Primitive Datatype = NormalizedString



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

def course_code
  @course_code
end

#date_last_modified ⇒ Object

Model Primitive Datatype = DateTime



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

def date_last_modified
  @date_last_modified
end

#grades ⇒ Object

Model Primitive Datatype = NormalizedString



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

def grades
  @grades
end

#metadata ⇒ Object

…tbd (Class description)…



48
49
50
 
# File 'lib/oneroster_client/models/course_type.rb', line 48

def metadata
  @metadata
end

#org ⇒ Object

Returns the value of attribute org.



32
33
34
 
# File 'lib/oneroster_client/models/course_type.rb', line 32

def org
  @org
end

#resources ⇒ Object

Returns the value of attribute resources.



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

def resources
  @resources
end

#school_year ⇒ Object

Returns the value of attribute school_year.



21
22
23
 
# File 'lib/oneroster_client/models/course_type.rb', line 21

def school_year
  @school_year
end

#sourced_id ⇒ Object

…tbd (Class description)…



40
41
42
 
# File 'lib/oneroster_client/models/course_type.rb', line 40

def sourced_id
  @sourced_id
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#subject_codes ⇒ Object

Model Primitive Datatype = NormalizedString



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

def subject_codes
  @subject_codes
end

#subjects ⇒ Object

Model Primitive Datatype = NormalizedString



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

def subjects
  @subjects
end

#title ⇒ Object

Model Primitive Datatype = NormalizedString



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oneroster_client/models/course_type.rb', line 73

def self.attribute_map
  {
    :'title' => :'title',
    :'school_year' => :'schoolYear',
    :'course_code' => :'courseCode',
    :'grades' => :'grades',
    :'subjects' => :'subjects',
    :'org' => :'org',
    :'subject_codes' => :'subjectCodes',
    :'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



273
274
275
 
# File 'lib/oneroster_client/models/course_type.rb', line 273

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/oneroster_client/models/course_type.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oneroster_client/models/course_type.rb', line 91

def self.openapi_types
  {
    :'title' => :'String',
    :'school_year' => :'GUIDRefType',
    :'course_code' => :'String',
    :'grades' => :'Array<String>',
    :'subjects' => :'Array<String>',
    :'org' => :'GUIDRefType',
    :'subject_codes' => :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      school_year == o.school_year &&
      course_code == o.course_code &&
      grades == o.grades &&
      subjects == o.subjects &&
      org == o.org &&
      subject_codes == o.subject_codes &&
      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



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
339
 
# File 'lib/oneroster_client/models/course_type.rb', line 304

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



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

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



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

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


260
261
262
 
# File 'lib/oneroster_client/models/course_type.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/oneroster_client/models/course_type.rb', line 266

def hash
  [title, school_year, course_code, grades, subjects, org, subject_codes, 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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oneroster_client/models/course_type.rb', line 191

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

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



349
350
351
 
# File 'lib/oneroster_client/models/course_type.rb', line 349

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



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

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



343
344
345
 
# File 'lib/oneroster_client/models/course_type.rb', line 343

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



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oneroster_client/models/course_type.rb', line 218

def valid?
  return false if @title.nil?
  return false if @course_code.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