Class: FlatApi::Assignment
- Inherits:
-
Object
- Object
- FlatApi::Assignment
- Defined in:
- lib/flat_api/models/assignment.rb
Overview
Assignment details
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#attachments ⇒ Object
Returns the value of attribute attachments.
-
#classroom ⇒ Object
The unique identifier of the class where this assignment was posted.
-
#creation_date ⇒ Object
The creation date of this assignment.
-
#creator ⇒ Object
The User unique identifier of the creator of this assignment.
-
#description ⇒ Object
Description and content of the assignment.
-
#due_date ⇒ Object
The due date of this assignment, late submissions will be marked as paste due.
-
#google_classroom ⇒ Object
Returns the value of attribute google_classroom.
-
#scheduled_date ⇒ Object
The publication (scheduled) date of the assignment.
-
#state ⇒ Object
State of the assignment.
-
#submissions ⇒ Object
Returns the value of attribute submissions.
-
#title ⇒ Object
Title of the assignment.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Assignment
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Assignment
Initializes the object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# 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. = 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 |
Instance Attribute Details
#attachments ⇒ Object
Returns the value of attribute attachments.
30 31 32 |
# File 'lib/flat_api/models/assignment.rb', line 30 def @attachments end |
#classroom ⇒ Object
The unique identifier of the class where this assignment was posted
25 26 27 |
# File 'lib/flat_api/models/assignment.rb', line 25 def classroom @classroom end |
#creation_date ⇒ Object
The creation date of this assignment
38 39 40 |
# File 'lib/flat_api/models/assignment.rb', line 38 def creation_date @creation_date end |
#creator ⇒ Object
The User unique identifier of the creator of this assignment
35 36 37 |
# File 'lib/flat_api/models/assignment.rb', line 35 def creator @creator end |
#description ⇒ Object
Description and content of the assignment
28 29 30 |
# File 'lib/flat_api/models/assignment.rb', line 28 def description @description end |
#due_date ⇒ Object
The due date of this assignment, late submissions will be marked as paste due.
44 45 46 |
# File 'lib/flat_api/models/assignment.rb', line 44 def due_date @due_date end |
#google_classroom ⇒ Object
Returns the value of attribute google_classroom.
46 47 48 |
# File 'lib/flat_api/models/assignment.rb', line 46 def google_classroom @google_classroom end |
#scheduled_date ⇒ Object
The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.
41 42 43 |
# File 'lib/flat_api/models/assignment.rb', line 41 def scheduled_date @scheduled_date end |
#state ⇒ Object
State of the assignment
19 20 21 |
# File 'lib/flat_api/models/assignment.rb', line 19 def state @state end |
#submissions ⇒ Object
Returns the value of attribute submissions.
32 33 34 |
# File 'lib/flat_api/models/assignment.rb', line 32 def submissions @submissions end |
#title ⇒ Object
Title of the assignment
22 23 24 |
# File 'lib/flat_api/models/assignment.rb', line 22 def title @title end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# 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 && == o. && 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) ⇒ Object
Deserializes the data based on type
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# 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) ⇒ Object
Builds the object from hash
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# 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) ⇒ Boolean
207 208 209 |
# File 'lib/flat_api/models/assignment.rb', line 207 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
213 214 215 |
# File 'lib/flat_api/models/assignment.rb', line 213 def hash [state, title, classroom, description, , submissions, creator, creation_date, scheduled_date, due_date, google_classroom].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
164 165 166 167 |
# File 'lib/flat_api/models/assignment.rb', line 164 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
287 288 289 |
# File 'lib/flat_api/models/assignment.rb', line 287 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
293 294 295 296 297 298 299 300 301 |
# 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 ⇒ String
Returns the string representation of the object
281 282 283 |
# File 'lib/flat_api/models/assignment.rb', line 281 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
171 172 173 174 175 |
# 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 |