Class: SwaggerClient::SubstituteTeacherClass

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/substitute_teacher_class.rb

Overview

Represents a single class instance. Used in SubstituteClassTeacher endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubstituteTeacherClass

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 132

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

When ‘true`, indicates that the class is being shown to clients in consumer mode.



49
50
51
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 49

def active
  @active
end

#class_description ⇒ Object

Contains information about this class.



73
74
75
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 73

def class_description
  @class_description
end

#class_schedule_id ⇒ Object

The class schedule ID of the requested class.



19
20
21
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 19

def class_schedule_id
  @class_schedule_id
end

#end_date_time ⇒ Object

The date and time when this class is scheduled to end.



67
68
69
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 67

def end_date_time
  @end_date_time
end

#hide_cancel ⇒ Object

When ‘true`, indicates that this class is should not be shown to clients when `IsCancelled` is `true`.<br /> When `false`, indicates that this class is should be shown to clients when `IsCancelled` is `true`.<br /> This property can be ignored when the `IsCancelled` property is `false`.



55
56
57
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 55

def hide_cancel
  @hide_cancel
end

#id ⇒ Object

The unique identifier of the class.



58
59
60
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 58

def id
  @id
end

#is_available ⇒ Object

When ‘true`, indicates that the class can be booked.<br /> When `false`, that the class cannot be booked at this time.



61
62
63
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 61

def is_available
  @is_available
end

#is_canceled ⇒ Object

When ‘true`, indicates that the class has been canceled.<br /> When `false`, indicates that the class has not been canceled and may still be bookable.



43
44
45
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 43

def is_canceled
  @is_canceled
end

#is_waitlist_available ⇒ Object

When ‘true`, indicates that the class has a waiting list and there is space available on the waiting list for another client.<br /> When `false`, indicates either that the class does not have a waiting list or there is no space available on the class waiting list.



52
53
54
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 52

def is_waitlist_available
  @is_waitlist_available
end

#last_modified_date_time ⇒ Object

The last time the class was modified.



70
71
72
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 70

def last_modified_date_time
  @last_modified_date_time
end

#location ⇒ Object

Contains information about the location where the class is taking place.



22
23
24
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 22

def location
  @location
end

#max_capacity ⇒ Object

The total number of bookings allowed in the class.



25
26
27
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 25

def max_capacity
  @max_capacity
end

#semester_id ⇒ Object

Identifies the semester assigned to this class.



40
41
42
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 40

def semester_id
  @semester_id
end

#staff ⇒ Object

Contains information about the teacher of the class.



76
77
78
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 76

def staff
  @staff
end

#start_date_time ⇒ Object

The date and time that this class is scheduled to start.



64
65
66
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 64

def start_date_time
  @start_date_time
end

#substitute ⇒ Object

When ‘true`, indicates that the class is being taught by a substitute teacher.



46
47
48
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 46

def substitute
  @substitute
end

#total_booked ⇒ Object

The total number of clients who are booked into the class prior to this call being made.



31
32
33
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 31

def total_booked
  @total_booked
end

#total_booked_waitlist ⇒ Object

The total number of booked clients who are on the waiting list for the class prior to this call being made.



34
35
36
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 34

def total_booked_waitlist
  @total_booked_waitlist
end

#web_booked ⇒ Object

The total number of bookings in the class made by online users, prior to this call being made. This property is the current number of bookings counted toward the ‘WebCapacity` limit.



37
38
39
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 37

def web_booked
  @web_booked
end

#web_capacity ⇒ Object

The total number of online bookings allowed in the class.



28
29
30
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 28

def web_capacity
  @web_capacity
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 79

def self.attribute_map
  {
    :'class_schedule_id' => :'ClassScheduleId',
    :'location' => :'Location',
    :'max_capacity' => :'MaxCapacity',
    :'web_capacity' => :'WebCapacity',
    :'total_booked' => :'TotalBooked',
    :'total_booked_waitlist' => :'TotalBookedWaitlist',
    :'web_booked' => :'WebBooked',
    :'semester_id' => :'SemesterId',
    :'is_canceled' => :'IsCanceled',
    :'substitute' => :'Substitute',
    :'active' => :'Active',
    :'is_waitlist_available' => :'IsWaitlistAvailable',
    :'hide_cancel' => :'HideCancel',
    :'id' => :'Id',
    :'is_available' => :'IsAvailable',
    :'start_date_time' => :'StartDateTime',
    :'end_date_time' => :'EndDateTime',
    :'last_modified_date_time' => :'LastModifiedDateTime',
    :'class_description' => :'ClassDescription',
    :'staff' => :'Staff'
  }
end

.swagger_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
125
126
127
128
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 105

def self.swagger_types
  {
    :'class_schedule_id' => :'Integer',
    :'location' => :'Location',
    :'max_capacity' => :'Integer',
    :'web_capacity' => :'Integer',
    :'total_booked' => :'Integer',
    :'total_booked_waitlist' => :'Integer',
    :'web_booked' => :'Integer',
    :'semester_id' => :'Integer',
    :'is_canceled' => :'BOOLEAN',
    :'substitute' => :'BOOLEAN',
    :'active' => :'BOOLEAN',
    :'is_waitlist_available' => :'BOOLEAN',
    :'hide_cancel' => :'BOOLEAN',
    :'id' => :'Integer',
    :'is_available' => :'BOOLEAN',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'last_modified_date_time' => :'DateTime',
    :'class_description' => :'ClassDescription',
    :'staff' => :'Staff'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_schedule_id == o.class_schedule_id &&
      location == o.location &&
      max_capacity == o.max_capacity &&
      web_capacity == o.web_capacity &&
      total_booked == o.total_booked &&
      total_booked_waitlist == o.total_booked_waitlist &&
      web_booked == o.web_booked &&
      semester_id == o.semester_id &&
      is_canceled == o.is_canceled &&
      substitute == o.substitute &&
      active == o.active &&
      is_waitlist_available == o.is_waitlist_available &&
      hide_cancel == o.hide_cancel &&
      id == o.id &&
      is_available == o.is_available &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      last_modified_date_time == o.last_modified_date_time &&
      class_description == o.class_description &&
      staff == o.staff
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



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
327
328
329
330
331
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 295

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 361

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 274

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


261
262
263
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 267

def hash
  [class_schedule_id, location, max_capacity, web_capacity, total_booked, total_booked_waitlist, web_booked, semester_id, is_canceled, substitute, active, is_waitlist_available, hide_cancel, id, is_available, start_date_time, end_date_time, last_modified_date_time, class_description, staff].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



221
222
223
224
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 221

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



341
342
343
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 341

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



347
348
349
350
351
352
353
354
355
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 347

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



335
336
337
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 335

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



228
229
230
 
# File 'lib/swagger_client/models/substitute_teacher_class.rb', line 228

def valid?
  true
end