Class: LUSI::API::Person::StaffCourseRole

Inherits:

Core::Code

• Object
• Core::BasicCode
• Core::Code
• LUSI::API::Person::StaffCourseRole

Defined in:

lib/lusi_api/person/staff.rb

Overview

Represents a staff course role in the LUSI API

Instance Attribute Summary

• #vle_role_description ⇒ String^?

  The VLE role description.

Attributes inherited from Core::BasicCode

#description, #identity

Class Method Summary

• .get_instance(api = nil, lookup = nil, **kwargs) ⇒ Array<LUSI::API::Person::StaffCourseRole>^?

  Returns an instance of StaffCourseRole matching the specified parameters.

Instance Method Summary

• #initialize(xml = nil, lookup = nil, vle_role_description: nil, **kwargs) ⇒ void constructor

  Initialises a new StaffCourseRole instance.

Methods inherited from Core::BasicCode

#to_s

Constructor Details

#initialize(xml = nil, lookup = nil, vle_role_description: nil, **kwargs) ⇒ void

Initialises a new StaffCourseRole instance

Parameters:

• vle_role_description (String, nil) (defaults to: nil) —

  the default VLE role description

# 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

Instance Attribute Details

#vle_role_description ⇒ String^?

Returns the VLE role description.

Returns:

• (String, nil) —

  the VLE role description

# File 'lib/lusi_api/person/staff.rb', line 15

def vle_role_description
  @vle_role_description
end

Class Method Details

.get_instance(api = nil, lookup = nil, **kwargs) ⇒ Array<LUSI::API::Person::StaffCourseRole>^?

Returns an instance of StaffCourseRole matching the specified parameters

Parameters:

• api (LUSI::API::Core::API, nil) (defaults to: nil) —

  the LUSI API instance

• lookup (LUSI::API::Core::Lookup::LookupService, nil) (defaults to: nil) —

  the lookup service for object resolution

Returns:

• (Array<LUSI::API::Person::StaffCourseRole>, nil)

# 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