Class: LUSI::API::Enrolment::EnrolmentRole

Inherits:

Core::Code

• Object
• Core::BasicCode
• Core::Code
• LUSI::API::Enrolment::EnrolmentRole

Defined in:

lib/lusi_api/enrolment.rb

Overview

Represents an enrolment role in the LUSI API

Instance Attribute Summary

• #vle_role_description ⇒ String^?

  The VLE role description a member has against this enrolment.

Attributes inherited from Core::BasicCode

#description, #identity

Instance Method Summary

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

  Initialises a new EnrolmentRole instance.

Methods inherited from Core::Code

get_instance

Methods inherited from Core::BasicCode

get_instance, #to_s

Constructor Details

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

Initialises a new EnrolmentRole instance

Parameters:

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

  the default VLE role description

# File 'lib/lusi_api/enrolment.rb', line 21

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 a member has against this enrolment.

Returns:

• (String, nil) —

  the VLE role description a member has against this enrolment

# File 'lib/lusi_api/enrolment.rb', line 15

def vle_role_description
  @vle_role_description
end