Class: Clever::Section

Inherits:
Object
  • Object
show all
Defined in:
lib/clever-ruby/models/section.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Section

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/clever-ruby/models/section.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#course ⇒ Object

Returns the value of attribute course.



18
19
20
 
# File 'lib/clever-ruby/models/section.rb', line 18

def course
  @course
end

#created ⇒ Object

Returns the value of attribute created.



20
21
22
 
# File 'lib/clever-ruby/models/section.rb', line 20

def created
  @created
end

#district ⇒ Object

Returns the value of attribute district.



22
23
24
 
# File 'lib/clever-ruby/models/section.rb', line 22

def district
  @district
end

#grade ⇒ Object

Returns the value of attribute grade.



24
25
26
 
# File 'lib/clever-ruby/models/section.rb', line 24

def grade
  @grade
end

#id ⇒ Object

Returns the value of attribute id.



26
27
28
 
# File 'lib/clever-ruby/models/section.rb', line 26

def id
  @id
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



28
29
30
 
# File 'lib/clever-ruby/models/section.rb', line 28

def last_modified
  @last_modified
end

#name ⇒ Object

Returns the value of attribute name.



30
31
32
 
# File 'lib/clever-ruby/models/section.rb', line 30

def name
  @name
end

#period ⇒ Object

Returns the value of attribute period.



32
33
34
 
# File 'lib/clever-ruby/models/section.rb', line 32

def period
  @period
end

#school ⇒ Object

Returns the value of attribute school.



34
35
36
 
# File 'lib/clever-ruby/models/section.rb', line 34

def school
  @school
end

#section_number ⇒ Object

Returns the value of attribute section_number.



36
37
38
 
# File 'lib/clever-ruby/models/section.rb', line 36

def section_number
  @section_number
end

#sis_id ⇒ Object

Returns the value of attribute sis_id.



38
39
40
 
# File 'lib/clever-ruby/models/section.rb', line 38

def sis_id
  @sis_id
end

#students ⇒ Object

Returns the value of attribute students.



40
41
42
 
# File 'lib/clever-ruby/models/section.rb', line 40

def students
  @students
end

#subject ⇒ Object

Returns the value of attribute subject.



42
43
44
 
# File 'lib/clever-ruby/models/section.rb', line 42

def subject
  @subject
end

#teacher ⇒ Object

Returns the value of attribute teacher.



44
45
46
 
# File 'lib/clever-ruby/models/section.rb', line 44

def teacher
  @teacher
end

#teachers ⇒ Object

Returns the value of attribute teachers.



46
47
48
 
# File 'lib/clever-ruby/models/section.rb', line 46

def teachers
  @teachers
end

#term_id ⇒ Object

Returns the value of attribute term_id.



48
49
50
 
# File 'lib/clever-ruby/models/section.rb', line 48

def term_id
  @term_id
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
89
90
91
92
 
# File 'lib/clever-ruby/models/section.rb', line 73

def self.attribute_map
  {
    :'course' => :'course',
    :'created' => :'created',
    :'district' => :'district',
    :'grade' => :'grade',
    :'id' => :'id',
    :'last_modified' => :'last_modified',
    :'name' => :'name',
    :'period' => :'period',
    :'school' => :'school',
    :'section_number' => :'section_number',
    :'sis_id' => :'sis_id',
    :'students' => :'students',
    :'subject' => :'subject',
    :'teacher' => :'teacher',
    :'teachers' => :'teachers',
    :'term_id' => :'term_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/clever-ruby/models/section.rb', line 95

def self.swagger_types
  {
    :'course' => :'String',
    :'created' => :'String',
    :'district' => :'String',
    :'grade' => :'String',
    :'id' => :'String',
    :'last_modified' => :'String',
    :'name' => :'String',
    :'period' => :'String',
    :'school' => :'String',
    :'section_number' => :'String',
    :'sis_id' => :'String',
    :'students' => :'Array<String>',
    :'subject' => :'String',
    :'teacher' => :'String',
    :'teachers' => :'Array<String>',
    :'term_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/clever-ruby/models/section.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      course == o.course &&
      created == o.created &&
      district == o.district &&
      grade == o.grade &&
      id == o.id &&
      last_modified == o.last_modified &&
      name == o.name &&
      period == o.period &&
      school == o.school &&
      section_number == o.section_number &&
      sis_id == o.sis_id &&
      students == o.students &&
      subject == o.subject &&
      teacher == o.teacher &&
      teachers == o.teachers &&
      term_id == o.term_id
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



290
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
 
# File 'lib/clever-ruby/models/section.rb', line 290

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 = Clever.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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/clever-ruby/models/section.rb', line 356

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/clever-ruby/models/section.rb', line 269

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


256
257
258
 
# File 'lib/clever-ruby/models/section.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



262
263
264
 
# File 'lib/clever-ruby/models/section.rb', line 262

def hash
  [course, created, district, grade, id, last_modified, name, period, school, section_number, sis_id, students, subject, teacher, teachers, term_id].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



196
197
198
199
 
# File 'lib/clever-ruby/models/section.rb', line 196

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



336
337
338
 
# File 'lib/clever-ruby/models/section.rb', line 336

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



342
343
344
345
346
347
348
349
350
 
# File 'lib/clever-ruby/models/section.rb', line 342

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



330
331
332
 
# File 'lib/clever-ruby/models/section.rb', line 330

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



203
204
205
206
207
208
209
 
# File 'lib/clever-ruby/models/section.rb', line 203

def valid?
  grade_validator = EnumAttributeValidator.new('String', ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "PreKindergarten", "Kindergarten", "PostGraduate", "Other"])
  return false unless grade_validator.valid?(@grade)
  subject_validator = EnumAttributeValidator.new('String', ["english/language arts", "math", "science", "social studies", "language", "homeroom/advisory", "interventions/online learning", "technology and engineering", "PE and health", "arts and music", "other"])
  return false unless subject_validator.valid?(@subject)
  return true
end