Class: OneRosterClient::AcademicSessionType

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

#children ⇒ Object

Returns the value of attribute children.



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

def children
  @children
end

#date_last_modified ⇒ Object

Model Primitive Datatype = DateTime



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

def date_last_modified
  @date_last_modified
end

#end_date ⇒ Object

Model Primitive Datatype = Date



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

def end_date
  @end_date
end

#metadata ⇒ Object

…tbd (Class description)…



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

def metadata
  @metadata
end

#parent ⇒ Object

Returns the value of attribute parent.



29
30
31
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 29

def parent
  @parent
end

#school_year ⇒ Object

Model Primitive Datatype = NormalizedString



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

def school_year
  @school_year
end

#sourced_id ⇒ Object

…tbd (Class description)…



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

def sourced_id
  @sourced_id
end

#start_date ⇒ Object

Model Primitive Datatype = Date



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

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#title ⇒ Object

Model Primitive Datatype = NormalizedString



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

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 70

def self.attribute_map
  {
    :'title' => :'title',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'type' => :'type',
    :'parent' => :'parent',
    :'children' => :'children',
    :'school_year' => :'schoolYear',
    :'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



284
285
286
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 284

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 87

def self.openapi_types
  {
    :'title' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'type' => :'String',
    :'parent' => :'GUIDRefType',
    :'children' => :'Array<GUIDRefType>',
    :'school_year' => :'Integer',
    :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      type == o.type &&
      parent == o.parent &&
      children == o.children &&
      school_year == o.school_year &&
      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



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
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 315

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 384

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



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

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


271
272
273
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 277

def hash
  [title, start_date, end_date, type, parent, children, school_year, 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



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

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

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

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

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

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



360
361
362
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 366

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



354
355
356
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 354

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oneroster_client/models/academic_session_type.rb', line 215

def valid?
  return false if @title.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('', ['gradingPeriod', 'semester', 'schoolYear', 'term'])
  return false unless type_validator.valid?(@type)
  return false if @school_year.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