class FlatApi::Assignment

Assignment details

Attributes

attachments[RW]
classroom[RW]

The unique identifier of the class where this assignment was posted

creation_date[RW]

The creation date of this assignment

creator[RW]

The User unique identifier of the creator of this assignment

description[RW]

Description and content of the assignment

due_date[RW]

The due date of this assignment, late submissions will be marked as paste due.

google_classroom[RW]
scheduled_date[RW]

The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.

state[RW]

State of the assignment

submissions[RW]
title[RW]

Title of the assignment

Public Class Methods

attribute_map() click to toggle source

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

# File lib/flat_api/models/assignment.rb, line 71
def self.attribute_map
  {
    :'state' => :'state',
    :'title' => :'title',
    :'classroom' => :'classroom',
    :'description' => :'description',
    :'attachments' => :'attachments',
    :'submissions' => :'submissions',
    :'creator' => :'creator',
    :'creation_date' => :'creationDate',
    :'scheduled_date' => :'scheduledDate',
    :'due_date' => :'dueDate',
    :'google_classroom' => :'googleClassroom'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/flat_api/models/assignment.rb, line 106
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?(:'state')
    self.state = attributes[:'state']
  end

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/assignment.rb, line 88
def self.swagger_types
  {
    :'state' => :'String',
    :'title' => :'String',
    :'classroom' => :'String',
    :'description' => :'String',
    :'attachments' => :'Array<MediaAttachment>',
    :'submissions' => :'Array<AssignmentSubmission>',
    :'creator' => :'String',
    :'creation_date' => :'DateTime',
    :'scheduled_date' => :'DateTime',
    :'due_date' => :'DateTime',
    :'google_classroom' => :'GoogleClassroomCoursework'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/flat_api/models/assignment.rb, line 189
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      title == o.title &&
      classroom == o.classroom &&
      description == o.description &&
      attachments == o.attachments &&
      submissions == o.submissions &&
      creator == o.creator &&
      creation_date == o.creation_date &&
      scheduled_date == o.scheduled_date &&
      due_date == o.due_date &&
      google_classroom == o.google_classroom
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/flat_api/models/assignment.rb, line 241
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 =~ /\A(true|t|yes|y|1)\z/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 = FlatApi.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/flat_api/models/assignment.rb, line 307
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/flat_api/models/assignment.rb, line 220
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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/flat_api/models/assignment.rb, line 207
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/flat_api/models/assignment.rb, line 213
def hash
  [state, title, classroom, description, attachments, submissions, creator, creation_date, scheduled_date, due_date, google_classroom].hash
end
list_invalid_properties() click to toggle source

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

# File lib/flat_api/models/assignment.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/flat_api/models/assignment.rb, line 179
def state=(state)
  validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}."
  end
  @state = state
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/flat_api/models/assignment.rb, line 287
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/flat_api/models/assignment.rb, line 293
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/flat_api/models/assignment.rb, line 281
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/flat_api/models/assignment.rb, line 171
def valid?
  state_validator = EnumAttributeValidator.new('String', ["draft", "active", "archived"])
  return false unless state_validator.valid?(@state)
  return true
end