Class: MicrosoftGraph::Models::EducationSchool

Inherits:
EducationOrganization show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/education_school.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EducationOrganization

#description, #description=, #display_name, #display_name=, #external_source, #external_source=, #external_source_detail, #external_source_detail=

Methods inherited from Entity

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

Constructor Details

#initialize ⇒ Object

Instantiates a new educationSchool and sets the default values.



100
101
102
103
 
# File 'lib/models/education_school.rb', line 100

def initialize()
    super
    @odata_type = "#microsoft.graph.educationSchool"
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_school

Raises:

  • (StandardError) 


124
125
126
127
 
# File 'lib/models/education_school.rb', line 124

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

Instance Method Details

#address ⇒ Object

Gets the address property value. Address of the school.

Returns:

  • a physical_address



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

def address
    return @address
end

#address=(value) ⇒ Object

Sets the address property value. Address of the school.

Parameters:

  • value —

    Value to set for the address property.

Returns:

  • a void



63
64
65
 
# File 'lib/models/education_school.rb', line 63

def address=(value)
    @address = value
end

#administrative_unit ⇒ Object

Gets the administrativeUnit property value. The underlying administrativeUnit for this school.

Returns:

  • a administrative_unit



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

def administrative_unit
    return @administrative_unit
end

#administrative_unit=(value) ⇒ Object

Sets the administrativeUnit property value. The underlying administrativeUnit for this school.

Parameters:

  • value —

    Value to set for the administrativeUnit property.

Returns:

  • a void



78
79
80
 
# File 'lib/models/education_school.rb', line 78

def administrative_unit=(value)
    @administrative_unit = value
end

#classes ⇒ Object

Gets the classes property value. Classes taught at the school. Nullable.

Returns:

  • a education_class



85
86
87
 
# File 'lib/models/education_school.rb', line 85

def classes
    return @classes
end

#classes=(value) ⇒ Object

Sets the classes property value. Classes taught at the school. Nullable.

Parameters:

  • value —

    Value to set for the classes property.

Returns:

  • a void



93
94
95
 
# File 'lib/models/education_school.rb', line 93

def classes=(value)
    @classes = value
end

#created_by ⇒ Object

Gets the createdBy property value. Entity who created the school.

Returns:

  • a identity_set



108
109
110
 
# File 'lib/models/education_school.rb', line 108

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. Entity who created the school.

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



116
117
118
 
# File 'lib/models/education_school.rb', line 116

def created_by=(value)
    @created_by = value
end

#external_id ⇒ Object

Gets the externalId property value. ID of school in syncing system.

Returns:

  • a string



132
133
134
 
# File 'lib/models/education_school.rb', line 132

def external_id
    return @external_id
end

#external_id=(value) ⇒ Object

Sets the externalId property value. ID of school in syncing system.

Parameters:

  • value —

    Value to set for the externalId property.

Returns:

  • a void



140
141
142
 
# File 'lib/models/education_school.rb', line 140

def external_id=(value)
    @external_id = value
end

#external_principal_id ⇒ Object

Gets the externalPrincipalId property value. ID of principal in syncing system.

Returns:

  • a string



147
148
149
 
# File 'lib/models/education_school.rb', line 147

def external_principal_id
    return @external_principal_id
end

#external_principal_id=(value) ⇒ Object

Sets the externalPrincipalId property value. ID of principal in syncing system.

Parameters:

  • value —

    Value to set for the externalPrincipalId property.

Returns:

  • a void



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

def external_principal_id=(value)
    @external_principal_id = value
end

#fax ⇒ Object

Gets the fax property value. The fax property

Returns:

  • a string



162
163
164
 
# File 'lib/models/education_school.rb', line 162

def fax
    return @fax
end

#fax=(value) ⇒ Object

Sets the fax property value. The fax property

Parameters:

  • value —

    Value to set for the fax property.

Returns:

  • a void



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

def fax=(value)
    @fax = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/models/education_school.rb', line 177

def get_field_deserializers()
    return super.merge({
        "address" => lambda {|n| @address = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PhysicalAddress.create_from_discriminator_value(pn) }) },
        "administrativeUnit" => lambda {|n| @administrative_unit = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AdministrativeUnit.create_from_discriminator_value(pn) }) },
        "classes" => lambda {|n| @classes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationClass.create_from_discriminator_value(pn) }) },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "externalId" => lambda {|n| @external_id = n.get_string_value() },
        "externalPrincipalId" => lambda {|n| @external_principal_id = n.get_string_value() },
        "fax" => lambda {|n| @fax = n.get_string_value() },
        "highestGrade" => lambda {|n| @highest_grade = n.get_string_value() },
        "lowestGrade" => lambda {|n| @lowest_grade = n.get_string_value() },
        "phone" => lambda {|n| @phone = n.get_string_value() },
        "principalEmail" => lambda {|n| @principal_email = n.get_string_value() },
        "principalName" => lambda {|n| @principal_name = n.get_string_value() },
        "schoolNumber" => lambda {|n| @school_number = n.get_string_value() },
        "users" => lambda {|n| @users = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationUser.create_from_discriminator_value(pn) }) },
    })
end

#highest_grade ⇒ Object

Gets the highestGrade property value. Highest grade taught.

Returns:

  • a string



199
200
201
 
# File 'lib/models/education_school.rb', line 199

def highest_grade
    return @highest_grade
end

#highest_grade=(value) ⇒ Object

Sets the highestGrade property value. Highest grade taught.

Parameters:

  • value —

    Value to set for the highestGrade property.

Returns:

  • a void



207
208
209
 
# File 'lib/models/education_school.rb', line 207

def highest_grade=(value)
    @highest_grade = value
end

#lowest_grade ⇒ Object

Gets the lowestGrade property value. Lowest grade taught.

Returns:

  • a string



214
215
216
 
# File 'lib/models/education_school.rb', line 214

def lowest_grade
    return @lowest_grade
end

#lowest_grade=(value) ⇒ Object

Sets the lowestGrade property value. Lowest grade taught.

Parameters:

  • value —

    Value to set for the lowestGrade property.

Returns:

  • a void



222
223
224
 
# File 'lib/models/education_school.rb', line 222

def lowest_grade=(value)
    @lowest_grade = value
end

#phone ⇒ Object

Gets the phone property value. Phone number of school.

Returns:

  • a string



229
230
231
 
# File 'lib/models/education_school.rb', line 229

def phone
    return @phone
end

#phone=(value) ⇒ Object

Sets the phone property value. Phone number of school.

Parameters:

  • value —

    Value to set for the phone property.

Returns:

  • a void



237
238
239
 
# File 'lib/models/education_school.rb', line 237

def phone=(value)
    @phone = value
end

#principal_email ⇒ Object

Gets the principalEmail property value. Email address of the principal.

Returns:

  • a string



244
245
246
 
# File 'lib/models/education_school.rb', line 244

def principal_email
    return @principal_email
end

#principal_email=(value) ⇒ Object

Sets the principalEmail property value. Email address of the principal.

Parameters:

  • value —

    Value to set for the principalEmail property.

Returns:

  • a void



252
253
254
 
# File 'lib/models/education_school.rb', line 252

def principal_email=(value)
    @principal_email = value
end

#principal_name ⇒ Object

Gets the principalName property value. Name of the principal.

Returns:

  • a string



259
260
261
 
# File 'lib/models/education_school.rb', line 259

def principal_name
    return @principal_name
end

#principal_name=(value) ⇒ Object

Sets the principalName property value. Name of the principal.

Parameters:

  • value —

    Value to set for the principalName property.

Returns:

  • a void



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

def principal_name=(value)
    @principal_name = value
end

#school_number ⇒ Object

Gets the schoolNumber property value. School Number.

Returns:

  • a string



274
275
276
 
# File 'lib/models/education_school.rb', line 274

def school_number
    return @school_number
end

#school_number=(value) ⇒ Object

Sets the schoolNumber property value. School Number.

Parameters:

  • value —

    Value to set for the schoolNumber property.

Returns:

  • a void



282
283
284
 
# File 'lib/models/education_school.rb', line 282

def school_number=(value)
    @school_number = 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) 


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

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("address", @address)
    writer.write_object_value("administrativeUnit", @administrative_unit)
    writer.write_collection_of_object_values("classes", @classes)
    writer.write_object_value("createdBy", @created_by)
    writer.write_string_value("externalId", @external_id)
    writer.write_string_value("externalPrincipalId", @external_principal_id)
    writer.write_string_value("fax", @fax)
    writer.write_string_value("highestGrade", @highest_grade)
    writer.write_string_value("lowestGrade", @lowest_grade)
    writer.write_string_value("phone", @phone)
    writer.write_string_value("principalEmail", @principal_email)
    writer.write_string_value("principalName", @principal_name)
    writer.write_string_value("schoolNumber", @school_number)
    writer.write_collection_of_object_values("users", @users)
end

#users ⇒ Object

Gets the users property value. Users in the school. Nullable.

Returns:

  • a education_user



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

def users
    return @users
end

#users=(value) ⇒ Object

Sets the users property value. Users in the school. Nullable.

Parameters:

  • value —

    Value to set for the users property.

Returns:

  • a void



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

def users=(value)
    @users = value
end