class LUSI::API::Person::StaffCourseRole

Represents a staff course role in the LUSI API

Attributes

vle_role_description[RW]

@!attribute [rw] vle_role_description

@return [String, nil] the VLE role description

Public Class Methods

get_instance(api = nil, lookup = nil, **kwargs) click to toggle source

Returns an instance of StaffCourseRole matching the specified parameters @param api [LUSI::API::Core::API, nil] the LUSI API instance @param lookup [LUSI::API::Core::Lookup::LookupService, nil] the lookup service for object resolution @param (see LUSI::API::Core::Code#get_instance) @return [Array<LUSI::API::Person::StaffCourseRole>, nil]

Calls superclass method LUSI::API::Core::Code::get_instance
# File lib/lusi_api/person/staff.rb, line 22
def self.get_instance(api = nil, lookup = nil, **kwargs)
  super(api, lookup, 'LUSIReference', 'Lookup.asmx', 'GetStaffCourseRoles', 'xmlns:StaffCourseRole',
        result_class: StaffCourseRole, **kwargs)
end
new(xml = nil, lookup = nil, vle_role_description: nil, **kwargs) click to toggle source

Initialises a new StaffCourseRole instance @param (see LUSI::API::Core::Code#initialize) @param vle_role_description [String, nil] the default VLE role description @return [void]

Calls superclass method LUSI::API::Core::BasicCode::new
# File lib/lusi_api/person/staff.rb, line 31
def initialize(xml = nil, lookup = nil, vle_role_description: nil, **kwargs)
  super(xml, lookup, **kwargs)
  @vle_role_description = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:VLERoleDescription',
                                                              vle_role_description)
end