Class: LUSI::API::Person::Relationship

Inherits:

Object

• Object
• LUSI::API::Person::Relationship

Defined in:

lib/lusi_api/person/student.rb

Overview

Represents a student’s relationship with a member of staff

Instance Attribute Summary

• #staff_relationship ⇒ LUSI::API::Core::Code^?

  The staff relationship type.

• #user_contact ⇒ LUSI::API::Person::UserContact^?

  The related person’s contact details.

Instance Method Summary

• #initialize(xml = nil, lookup = nil, staff_relationship: nil, user_contact: nil) ⇒ Relationship constructor

  Initialises a new Relationship instance.

• #to_s ⇒ Object

  Returns a string representation of the relationship.

Constructor Details

#initialize(xml = nil, lookup = nil, staff_relationship: nil, user_contact: nil) ⇒ Relationship

Initialises a new Relationship instance

Parameters:

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

  the parsed XML root of the relationship

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

  the lookup service for object resolution

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

  the default staff relationship code

• user_contact (LUSI::API::Person::UserContact, nil) (defaults to: nil) —

  the default related person’s contact details

# File 'lib/lusi_api/person/student.rb', line 239

def initialize(xml = nil, lookup = nil, staff_relationship: nil, user_contact: nil)
  @staff_relationship = LUSI::API::Core::Code.new(
      LUSI::API::Core::XML.xml_at(xml, 'xmlns:StaffRelationship', staff_relationship), lookup)
  @user_contact = UserContact.new(LUSI::API::Core::XML.xml_at(xml, 'xmlns:UserContact', user_contact), lookup)
end

Instance Attribute Details

#staff_relationship ⇒ LUSI::API::Core::Code^?

Returns the staff relationship type.

Returns:

• (LUSI::API::Core::Code, nil) —

  the staff relationship type

# File 'lib/lusi_api/person/student.rb', line 228

def staff_relationship
  @staff_relationship
end

#user_contact ⇒ LUSI::API::Person::UserContact^?

Returns the related person’s contact details.

Returns:

• (LUSI::API::Person::UserContact, nil) —

  the related person’s contact details

# File 'lib/lusi_api/person/student.rb', line 232

def user_contact
  @user_contact
end

Instance Method Details

#to_s ⇒ Object

Returns a string representation of the relationship

# File 'lib/lusi_api/person/student.rb', line 246

def to_s
  contact = @user_contact ? @user_contact.contact_name : ''
  description = @staff_relationship ? "#{@staff_relationship.description}: " : ''
  "#{description}#{contact}"
end