Class: MicrosoftGraph::Models::EducationClass

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/education_class.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new educationClass and sets the default values.



148
149
150
 
# File 'lib/models/education_class.rb', line 148

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a education_class

Raises:

  • (StandardError) 


186
187
188
189
 
# File 'lib/models/education_class.rb', line 186

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return EducationClass.new
end

Instance Method Details

#assignment_categories ⇒ Object

Gets the assignmentCategories property value. All categories associated with this class. Nullable.

Returns:

  • a education_category



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

def assignment_categories
    return @assignment_categories
end

#assignment_categories=(value) ⇒ Object

Sets the assignmentCategories property value. All categories associated with this class. Nullable.

Parameters:

  • value —

    Value to set for the assignmentCategories property.

Returns:

  • a void



81
82
83
 
# File 'lib/models/education_class.rb', line 81

def assignment_categories=(value)
    @assignment_categories = value
end

#assignment_defaults ⇒ Object

Gets the assignmentDefaults property value. Specifies class-level defaults respected by new assignments created in the class.

Returns:

  • a education_assignment_defaults



88
89
90
 
# File 'lib/models/education_class.rb', line 88

def assignment_defaults
    return @assignment_defaults
end

#assignment_defaults=(value) ⇒ Object

Sets the assignmentDefaults property value. Specifies class-level defaults respected by new assignments created in the class.

Parameters:

  • value —

    Value to set for the assignmentDefaults property.

Returns:

  • a void



96
97
98
 
# File 'lib/models/education_class.rb', line 96

def assignment_defaults=(value)
    @assignment_defaults = value
end

#assignment_settings ⇒ Object

Gets the assignmentSettings property value. Specifies class-level assignments settings.

Returns:

  • a education_assignment_settings



103
104
105
 
# File 'lib/models/education_class.rb', line 103

def assignment_settings
    return @assignment_settings
end

#assignment_settings=(value) ⇒ Object

Sets the assignmentSettings property value. Specifies class-level assignments settings.

Parameters:

  • value —

    Value to set for the assignmentSettings property.

Returns:

  • a void



111
112
113
 
# File 'lib/models/education_class.rb', line 111

def assignment_settings=(value)
    @assignment_settings = value
end

#assignments ⇒ Object

Gets the assignments property value. All assignments associated with this class. Nullable.

Returns:

  • a education_assignment



118
119
120
 
# File 'lib/models/education_class.rb', line 118

def assignments
    return @assignments
end

#assignments=(value) ⇒ Object

Sets the assignments property value. All assignments associated with this class. Nullable.

Parameters:

  • value —

    Value to set for the assignments property.

Returns:

  • a void



126
127
128
 
# File 'lib/models/education_class.rb', line 126

def assignments=(value)
    @assignments = value
end

#class_code ⇒ Object

Gets the classCode property value. Class code used by the school to identify the class.

Returns:

  • a string



133
134
135
 
# File 'lib/models/education_class.rb', line 133

def class_code
    return @class_code
end

#class_code=(value) ⇒ Object

Sets the classCode property value. Class code used by the school to identify the class.

Parameters:

  • value —

    Value to set for the classCode property.

Returns:

  • a void



141
142
143
 
# File 'lib/models/education_class.rb', line 141

def class_code=(value)
    @class_code = value
end

#course ⇒ Object

Gets the course property value. The course property

Returns:

  • a education_course



155
156
157
 
# File 'lib/models/education_class.rb', line 155

def course
    return @course
end

#course=(value) ⇒ Object

Sets the course property value. The course property

Parameters:

  • value —

    Value to set for the course property.

Returns:

  • a void



163
164
165
 
# File 'lib/models/education_class.rb', line 163

def course=(value)
    @course = value
end

#created_by ⇒ Object

Gets the createdBy property value. Entity who created the class

Returns:

  • a identity_set



170
171
172
 
# File 'lib/models/education_class.rb', line 170

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. Entity who created the class

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



178
179
180
 
# File 'lib/models/education_class.rb', line 178

def created_by=(value)
    @created_by = value
end

#description ⇒ Object

Gets the description property value. Description of the class.

Returns:

  • a string



194
195
196
 
# File 'lib/models/education_class.rb', line 194

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. Description of the class.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



202
203
204
 
# File 'lib/models/education_class.rb', line 202

def description=(value)
    @description = value
end

#display_name ⇒ Object

Gets the displayName property value. Name of the class.

Returns:

  • a string



209
210
211
 
# File 'lib/models/education_class.rb', line 209

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. Name of the class.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



217
218
219
 
# File 'lib/models/education_class.rb', line 217

def display_name=(value)
    @display_name = value
end

#external_id ⇒ Object

Gets the externalId property value. ID of the class from the syncing system.

Returns:

  • a string



224
225
226
 
# File 'lib/models/education_class.rb', line 224

def external_id
    return @external_id
end

#external_id=(value) ⇒ Object

Sets the externalId property value. ID of the class from the syncing system.

Parameters:

  • value —

    Value to set for the externalId property.

Returns:

  • a void



232
233
234
 
# File 'lib/models/education_class.rb', line 232

def external_id=(value)
    @external_id = value
end

#external_name ⇒ Object

Gets the externalName property value. Name of the class in the syncing system.

Returns:

  • a string



239
240
241
 
# File 'lib/models/education_class.rb', line 239

def external_name
    return @external_name
end

#external_name=(value) ⇒ Object

Sets the externalName property value. Name of the class in the syncing system.

Parameters:

  • value —

    Value to set for the externalName property.

Returns:

  • a void



247
248
249
 
# File 'lib/models/education_class.rb', line 247

def external_name=(value)
    @external_name = value
end

#external_source ⇒ Object

Gets the externalSource property value. How this class was created. Possible values are: sis, manual.

Returns:

  • a education_external_source



254
255
256
 
# File 'lib/models/education_class.rb', line 254

def external_source
    return @external_source
end

#external_source=(value) ⇒ Object

Sets the externalSource property value. How this class was created. Possible values are: sis, manual.

Parameters:

  • value —

    Value to set for the externalSource property.

Returns:

  • a void



262
263
264
 
# File 'lib/models/education_class.rb', line 262

def external_source=(value)
    @external_source = value
end

#external_source_detail ⇒ Object

Gets the externalSourceDetail property value. The name of the external source this resources was generated from.

Returns:

  • a string



269
270
271
 
# File 'lib/models/education_class.rb', line 269

def external_source_detail
    return @external_source_detail
end

#external_source_detail=(value) ⇒ Object

Sets the externalSourceDetail property value. The name of the external source this resources was generated from.

Parameters:

  • value —

    Value to set for the externalSourceDetail property.

Returns:

  • a void



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

def external_source_detail=(value)
    @external_source_detail = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/models/education_class.rb', line 284

def get_field_deserializers()
    return super.merge({
        "assignmentCategories" => lambda {|n| @assignment_categories = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationCategory.create_from_discriminator_value(pn) }) },
        "assignmentDefaults" => lambda {|n| @assignment_defaults = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationAssignmentDefaults.create_from_discriminator_value(pn) }) },
        "assignmentSettings" => lambda {|n| @assignment_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationAssignmentSettings.create_from_discriminator_value(pn) }) },
        "assignments" => lambda {|n| @assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationAssignment.create_from_discriminator_value(pn) }) },
        "classCode" => lambda {|n| @class_code = n.get_string_value() },
        "course" => lambda {|n| @course = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationCourse.create_from_discriminator_value(pn) }) },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "externalId" => lambda {|n| @external_id = n.get_string_value() },
        "externalName" => lambda {|n| @external_name = n.get_string_value() },
        "externalSource" => lambda {|n| @external_source = n.get_enum_value(MicrosoftGraph::Models::EducationExternalSource) },
        "externalSourceDetail" => lambda {|n| @external_source_detail = n.get_string_value() },
        "grade" => lambda {|n| @grade = n.get_string_value() },
        "group" => lambda {|n| @group = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Group.create_from_discriminator_value(pn) }) },
        "mailNickname" => lambda {|n| @mail_nickname = n.get_string_value() },
        "members" => lambda {|n| @members = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationUser.create_from_discriminator_value(pn) }) },
        "schools" => lambda {|n| @schools = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationSchool.create_from_discriminator_value(pn) }) },
        "teachers" => lambda {|n| @teachers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationUser.create_from_discriminator_value(pn) }) },
        "term" => lambda {|n| @term = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationTerm.create_from_discriminator_value(pn) }) },
    })
end

#grade ⇒ Object

Gets the grade property value. Grade level of the class.

Returns:

  • a string



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

def grade
    return @grade
end

#grade=(value) ⇒ Object

Sets the grade property value. Grade level of the class.

Parameters:

  • value —

    Value to set for the grade property.

Returns:

  • a void



320
321
322
 
# File 'lib/models/education_class.rb', line 320

def grade=(value)
    @grade = value
end

#group ⇒ Object

Gets the group property value. The underlying Microsoft 365 group object.

Returns:

  • a group



327
328
329
 
# File 'lib/models/education_class.rb', line 327

def group
    return @group
end

#group=(value) ⇒ Object

Sets the group property value. The underlying Microsoft 365 group object.

Parameters:

  • value —

    Value to set for the group property.

Returns:

  • a void



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

def group=(value)
    @group = value
end

#mail_nickname ⇒ Object

Gets the mailNickname property value. Mail name for sending email to all members, if this is enabled.

Returns:

  • a string



342
343
344
 
# File 'lib/models/education_class.rb', line 342

def mail_nickname
    return @mail_nickname
end

#mail_nickname=(value) ⇒ Object

Sets the mailNickname property value. Mail name for sending email to all members, if this is enabled.

Parameters:

  • value —

    Value to set for the mailNickname property.

Returns:

  • a void



350
351
352
 
# File 'lib/models/education_class.rb', line 350

def mail_nickname=(value)
    @mail_nickname = value
end

#members ⇒ Object

Gets the members property value. All users in the class. Nullable.

Returns:

  • a education_user



357
358
359
 
# File 'lib/models/education_class.rb', line 357

def members
    return @members
end

#members=(value) ⇒ Object

Sets the members property value. All users in the class. Nullable.

Parameters:

  • value —

    Value to set for the members property.

Returns:

  • a void



365
366
367
 
# File 'lib/models/education_class.rb', line 365

def members=(value)
    @members = value
end

#schools ⇒ Object

Gets the schools property value. All schools that this class is associated with. Nullable.

Returns:

  • a education_school



372
373
374
 
# File 'lib/models/education_class.rb', line 372

def schools
    return @schools
end

#schools=(value) ⇒ Object

Sets the schools property value. All schools that this class is associated with. Nullable.

Parameters:

  • value —

    Value to set for the schools property.

Returns:

  • a void



380
381
382
 
# File 'lib/models/education_class.rb', line 380

def schools=(value)
    @schools = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/models/education_class.rb', line 388

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("assignmentCategories", @assignment_categories)
    writer.write_object_value("assignmentDefaults", @assignment_defaults)
    writer.write_object_value("assignmentSettings", @assignment_settings)
    writer.write_collection_of_object_values("assignments", @assignments)
    writer.write_string_value("classCode", @class_code)
    writer.write_object_value("course", @course)
    writer.write_object_value("createdBy", @created_by)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_string_value("externalId", @external_id)
    writer.write_string_value("externalName", @external_name)
    writer.write_enum_value("externalSource", @external_source)
    writer.write_string_value("externalSourceDetail", @external_source_detail)
    writer.write_string_value("grade", @grade)
    writer.write_object_value("group", @group)
    writer.write_string_value("mailNickname", @mail_nickname)
    writer.write_collection_of_object_values("members", @members)
    writer.write_collection_of_object_values("schools", @schools)
    writer.write_collection_of_object_values("teachers", @teachers)
    writer.write_object_value("term", @term)
end

#teachers ⇒ Object

Gets the teachers property value. All teachers in the class. Nullable.

Returns:

  • a education_user



416
417
418
 
# File 'lib/models/education_class.rb', line 416

def teachers
    return @teachers
end

#teachers=(value) ⇒ Object

Sets the teachers property value. All teachers in the class. Nullable.

Parameters:

  • value —

    Value to set for the teachers property.

Returns:

  • a void



424
425
426
 
# File 'lib/models/education_class.rb', line 424

def teachers=(value)
    @teachers = value
end

#term ⇒ Object

Gets the term property value. Term for this class.

Returns:

  • a education_term



431
432
433
 
# File 'lib/models/education_class.rb', line 431

def term
    return @term
end

#term=(value) ⇒ Object

Sets the term property value. Term for this class.

Parameters:

  • value —

    Value to set for the term property.

Returns:

  • a void



439
440
441
 
# File 'lib/models/education_class.rb', line 439

def term=(value)
    @term = value
end