Class: LUSI::API::Course::Length

Inherits:
Object
  • Object
show all
Defined in:
lib/lusi_api/course.rb

Overview

Represents the length of a scheme of study

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(xml = nil, lookup = nil, absolute_maximum: nil, maximum: nil, minimum: nil) ⇒ void

Initialises a new Length instance

Parameters:

  • xml (Nokogiri::XML::Document, Nokogiri::XML::Node) (defaults to: nil) —

    the parsed XML root of the length

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

    the lookup service for object resolution

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

    the default absolute maximum scheme length

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

    the default maximum scheme length

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

    the default minimum scheme length



658
659
660
661
662
 
# File 'lib/lusi_api/course.rb', line 658

def initialize(xml = nil, lookup = nil, absolute_maximum: nil, maximum: nil, minimum: nil)
  @absolute_maximum = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:AbsoluteMaximum', absolute_maximum)
  @maximum = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:Maximum', maximum)
  @minimum = LUSI::API::Core::XML.xml_content_at(xml, 'xmlns:Minimum', minimum)
end

Instance Attribute Details

#absolute_maximum ⇒ String?

Returns the absolute maximum scheme length.

Returns:

  • (String, nil) —

    the absolute maximum scheme length



641
642
643
 
# File 'lib/lusi_api/course.rb', line 641

def absolute_maximum
  @absolute_maximum
end

#maximum ⇒ String?

Returns the maximum scheme length.

Returns:

  • (String, nil) —

    the maximum scheme length



645
646
647
 
# File 'lib/lusi_api/course.rb', line 645

def maximum
  @maximum
end

#minimum ⇒ String?

Returns the minimum scheme length.

Returns:

  • (String, nil) —

    the minimum scheme length



649
650
651
 
# File 'lib/lusi_api/course.rb', line 649

def minimum
  @minimum
end

Instance Method Details

#to_s ⇒ String

Returns a string representation of the Length instance

Returns:

  • (String) —

    the string representation of the SchemeLength instance



666
667
668
 
# File 'lib/lusi_api/course.rb', line 666

def to_s
  "#{minimum} - #{maximum} (#{absolute_maximum})"
end