class BlueprintClient::NodeAttributes

Attributes

deadline[RW]

Deadline date for redemption period nodes, should be an ISO8601 date. Drop if we can get additionalProperties working.

description[RW]

A more detailed description of the node

domain_ids[RW]

Additional identifiers linked to the external domain of the hierarchy, for example JACS code. Allows comparisons between hierarchies.

reminder_date[RW]

Reminder date for redemption period nodes, should be an ISO8601 date. Drop if we can get additionalProperties working.

student_numbers[RW]
title[RW]
valid_from[RW]

The node is judged invalid before this date. Should be an ISO8601 date

valid_to[RW]

The node is judged invalid after this date. Should be an ISO8601 date

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 40
def self.attribute_map
  {
    
    :'title' => :'title',
    
    :'description' => :'description',
    
    :'valid_from' => :'valid_from',
    
    :'valid_to' => :'valid_to',
    
    :'student_numbers' => :'studentNumbers',
    
    :'domain_ids' => :'domain_ids',
    
    :'reminder_date' => :'reminder_date',
    
    :'deadline' => :'deadline'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 87
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'title')
    
    
    self.title = attributes[:'title']
    
  
  end

  
  if attributes.has_key?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

  
  if attributes.has_key?(:'valid_from')
    
    
    self.valid_from = attributes[:'valid_from']
    
  
  end

  
  if attributes.has_key?(:'valid_to')
    
    
    self.valid_to = attributes[:'valid_to']
    
  
  end

  
  if attributes.has_key?(:'studentNumbers')
    
    
    self.student_numbers = attributes[:'studentNumbers']
    
  
  end

  
  if attributes.has_key?(:'domain_ids')
    
    if (value = attributes[:'domain_ids']).is_a?(Array)
      self.domain_ids = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'reminder_date')
    
    
    self.reminder_date = attributes[:'reminder_date']
    
  
  end

  
  if attributes.has_key?(:'deadline')
    
    
    self.deadline = attributes[:'deadline']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 63
def self.swagger_types
  {
    
    :'title' => :'String',
    
    :'description' => :'String',
    
    :'valid_from' => :'Date',
    
    :'valid_to' => :'Date',
    
    :'student_numbers' => :'Float',
    
    :'domain_ids' => :'Array<String>',
    
    :'reminder_date' => :'Date',
    
    :'deadline' => :'Date'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 260
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      valid_from == o.valid_from &&
      valid_to == o.valid_to &&
      student_numbers == o.student_numbers &&
      domain_ids == o.domain_ids &&
      reminder_date == o.reminder_date &&
      deadline == o.deadline
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 309
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = BlueprintClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 375
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 288
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 275
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 281
def hash
  [title, description, valid_from, valid_to, student_numbers, domain_ids, reminder_date, deadline].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 172
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 355
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 361
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 349
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/blueprint_ruby_client/models/node_attributes.rb, line 181
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end