Class: VeriCiteClient::AssignmentData

Inherits:
Object
  • Object
show all
Defined in:
lib/vericite_client/models/assignment_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssignmentData

Returns a new instance of AssignmentData.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/vericite_client/models/assignment_data.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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


  if attributes[:'assignmentTitle']
    self.assignment_title = attributes[:'assignmentTitle']
  end

  if attributes[:'assignmentInstructions']
    self.assignment_instructions = attributes[:'assignmentInstructions']
  end

  if attributes[:'assignmentExcludeQuotes']
    self.assignment_exclude_quotes = attributes[:'assignmentExcludeQuotes']
  end

  if attributes[:'assignmentExcludeSelfPlag']
    self.assignment_exclude_self_plag = attributes[:'assignmentExcludeSelfPlag']
  end

  if attributes[:'assignmentStoreInIndex']
    self.assignment_store_in_index = attributes[:'assignmentStoreInIndex']
  end

  if attributes[:'assignmentEnableStudentPreview']
    self.assignment_enable_student_preview = attributes[:'assignmentEnableStudentPreview']
  end

  if attributes[:'assignmentDueDate']
    self.assignment_due_date = attributes[:'assignmentDueDate']
  end

  if attributes[:'assignmentGrade']
    self.assignment_grade = attributes[:'assignmentGrade']
  end

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

end

Instance Attribute Details

#assignment_attachment_external_content ⇒ Object

Returns the value of attribute assignment_attachment_external_content.



33
34
35
 
# File 'lib/vericite_client/models/assignment_data.rb', line 33

def assignment_attachment_external_content
  @assignment_attachment_external_content
end

#assignment_due_date ⇒ Object

Assignment due date. Pass in 0 to delete.



28
29
30
 
# File 'lib/vericite_client/models/assignment_data.rb', line 28

def assignment_due_date
  @assignment_due_date
end

#assignment_enable_student_preview ⇒ Object

enable student preview:



25
26
27
 
# File 'lib/vericite_client/models/assignment_data.rb', line 25

def assignment_enable_student_preview
  @assignment_enable_student_preview
end

#assignment_exclude_quotes ⇒ Object

exclude quotes



16
17
18
 
# File 'lib/vericite_client/models/assignment_data.rb', line 16

def assignment_exclude_quotes
  @assignment_exclude_quotes
end

#assignment_exclude_self_plag ⇒ Object

exclude self plagiarism



19
20
21
 
# File 'lib/vericite_client/models/assignment_data.rb', line 19

def assignment_exclude_self_plag
  @assignment_exclude_self_plag
end

#assignment_grade ⇒ Object

Assignment grade. Pass in 0 to delete.



31
32
33
 
# File 'lib/vericite_client/models/assignment_data.rb', line 31

def assignment_grade
  @assignment_grade
end

#assignment_instructions ⇒ Object

Instructions for assignment



13
14
15
 
# File 'lib/vericite_client/models/assignment_data.rb', line 13

def assignment_instructions
  @assignment_instructions
end

#assignment_store_in_index ⇒ Object

store in index



22
23
24
 
# File 'lib/vericite_client/models/assignment_data.rb', line 22

def assignment_store_in_index
  @assignment_store_in_index
end

#assignment_title ⇒ Object

The title of the assignment



10
11
12
 
# File 'lib/vericite_client/models/assignment_data.rb', line 10

def assignment_title
  @assignment_title
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vericite_client/models/assignment_data.rb', line 36

def self.attribute_map
  {

    :'assignment_title' => :'assignmentTitle',

    :'assignment_instructions' => :'assignmentInstructions',

    :'assignment_exclude_quotes' => :'assignmentExcludeQuotes',

    :'assignment_exclude_self_plag' => :'assignmentExcludeSelfPlag',

    :'assignment_store_in_index' => :'assignmentStoreInIndex',

    :'assignment_enable_student_preview' => :'assignmentEnableStudentPreview',

    :'assignment_due_date' => :'assignmentDueDate',

    :'assignment_grade' => :'assignmentGrade',

    :'assignment_attachment_external_content' => :'assignmentAttachmentExternalContent'

  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vericite_client/models/assignment_data.rb', line 61

def self.swagger_types
  {
    :'assignment_title' => :'String',
    :'assignment_instructions' => :'String',
    :'assignment_exclude_quotes' => :'BOOLEAN',
    :'assignment_exclude_self_plag' => :'BOOLEAN',
    :'assignment_store_in_index' => :'BOOLEAN',
    :'assignment_enable_student_preview' => :'BOOLEAN',
    :'assignment_due_date' => :'Integer',
    :'assignment_grade' => :'Integer',
    :'assignment_attachment_external_content' => :'Array<ExternalContentData>'

  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/vericite_client/models/assignment_data.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assignment_title == o.assignment_title &&
      assignment_instructions == o.assignment_instructions &&
      assignment_exclude_quotes == o.assignment_exclude_quotes &&
      assignment_exclude_self_plag == o.assignment_exclude_self_plag &&
      assignment_store_in_index == o.assignment_store_in_index &&
      assignment_enable_student_preview == o.assignment_enable_student_preview &&
      assignment_due_date == o.assignment_due_date &&
      assignment_grade == o.assignment_grade &&
      assignment_attachment_external_content == o.assignment_attachment_external_content
end

#_deserialize(type, value) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/vericite_client/models/assignment_data.rb', line 168

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
    _model = VeriCiteClient.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/vericite_client/models/assignment_data.rb', line 228

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

build the object from hash



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/vericite_client/models/assignment_data.rb', line 149

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


139
140
141
 
# File 'lib/vericite_client/models/assignment_data.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



144
145
146
 
# File 'lib/vericite_client/models/assignment_data.rb', line 144

def hash
  [assignment_title, assignment_instructions, assignment_exclude_quotes, assignment_exclude_self_plag, assignment_exclude_self_plag, assignment_due_date, assignment_grade, assignment_attachment_external_content].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



211
212
213
 
# File 'lib/vericite_client/models/assignment_data.rb', line 211

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



216
217
218
219
220
221
222
223
224
 
# File 'lib/vericite_client/models/assignment_data.rb', line 216

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 ⇒ Object 



206
207
208
 
# File 'lib/vericite_client/models/assignment_data.rb', line 206

def to_s
  to_hash.to_s
end