Class: LUSI::API::Course::SchemeOfStudyEnrolment

Inherits:

CourseEnrolment

• Object
• Enrolment::EnrolmentBase
• CourseEnrolment
• LUSI::API::Course::SchemeOfStudyEnrolment

Defined in:

lib/lusi_api/course.rb

Overview

Represents a module enrolment in the LUSI API

Direct Known Subclasses

StaffSchemeOfStudyEnrolment, StudentSchemeOfStudyEnrolment

Instance Attribute Summary

• #scheme_identity ⇒ LUSI::API::Course::EnrolmentIdentity (also: #course_identity)

  The enrolment’s scheme of study identity.

Attributes inherited from Enrolment::EnrolmentBase

#enrolment_role, #identity, #is_current_enrolment, #is_current_identity, #username

Class Method Summary

• .lookup_index ⇒ Object
• .lusi_ws_method ⇒ Object
• .lusi_ws_xml_root ⇒ Object

Instance Method Summary

• #initialize(xml = nil, lookup = nil, scheme_identity: nil, **kwargs) ⇒ SchemeOfStudyEnrolment constructor

  A new instance of SchemeOfStudyEnrolment.

Methods inherited from CourseEnrolment

#lookup_indices, #lookup_key

Methods inherited from Enrolment::EnrolmentBase

get_instance, #lookup_indices, #lookup_key, lusi_ws_path

Methods included from LUSI::API::Core::Endpoint

#lusi_ws_endpoint, #lusi_ws_method, #lusi_ws_path, #lusi_ws_xml_root

Constructor Details

#initialize(xml = nil, lookup = nil, scheme_identity: nil, **kwargs) ⇒ SchemeOfStudyEnrolment

Returns a new instance of SchemeOfStudyEnrolment.

Parameters:

• scheme_identity (LUSI::API::Course::EnrolmentIdentity) (defaults to: nil) —

  the enrolment’s scheme of study identity

See Also:

• LUSI::API::Course::SchemeOfStudyEnrolment.(LUSI(LUSI::API(LUSI::API::Enrolment(LUSI::API::Enrolment::EnrolmentBase(LUSI::API::Enrolment::EnrolmentBase#initialize)

# File 'lib/lusi_api/course.rb', line 905

def initialize(xml = nil, lookup = nil, scheme_identity: nil, **kwargs)
  super(xml, lookup, **kwargs)
  @scheme_identity = EnrolmentIdentity.new(LUSI::API::Core::XML.xml_at(xml, 'xmlns:SchemeIdentity',
                                                                       scheme_identity), lookup)
end

Instance Attribute Details

#scheme_identity ⇒ LUSI::API::Course::EnrolmentIdentity Also known as: course_identity

Returns the enrolment’s scheme of study identity.

Returns:

• (LUSI::API::Course::EnrolmentIdentity) —

  the enrolment’s scheme of study identity

# File 'lib/lusi_api/course.rb', line 885

def scheme_identity
  @scheme_identity
end

Class Method Details

.lookup_index ⇒ Object

Raises:

• (NotImplementedError)

See Also:

• (LUSI(LUSI::API(LUSI::API::Course(LUSI::API::Course::CourseEnrolment(LUSI::API::Course::CourseEnrolment#lookup_index)

# File 'lib/lusi_api/course.rb', line 889

def self.lookup_index
  raise NotImplementedError
end

.lusi_ws_method ⇒ Object

See Also:

• (LUSI(LUSI::API(LUSI::API::Core(LUSI::API::Core::Endpoint(LUSI::API::Core::Endpoint#lusi_ws_method)

# File 'lib/lusi_api/course.rb', line 894

def self.lusi_ws_method
  'BulkGetSchemeOfStudyEnrolments'
end

.lusi_ws_xml_root ⇒ Object

See Also:

• (LUSI(LUSI::API(LUSI::API::Core(LUSI::API::Core::Endpoint(LUSI::API::Core::Endpoint#lusi_ws_xml_root)

# File 'lib/lusi_api/course.rb', line 899

def self.lusi_ws_xml_root
  'BulkSchemeOfStudyEnrolment'
end