Class: TCAClient::SubmissionBase

Inherits:
Object
  • Object
show all
Defined in:
lib/tca_client/models/submission_base.rb

Overview

A Submission is the base object on which other services (such as similarity) are offered. In order to use other services a Submission must first be created and successfully process, then other service objects can be created.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmissionBase

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



102
103
104
105
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
 
# File 'lib/tca_client/models/submission_base.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::SubmissionBase` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TCAClient::SubmissionBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'owner')
    self.owner = attributes[:'owner']
  end

  if attributes.key?(:'owner_default_permission_set')
    self.owner_default_permission_set = attributes[:'owner_default_permission_set']
  end

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

  if attributes.key?(:'submitter')
    self.submitter = attributes[:'submitter']
  end

  if attributes.key?(:'submitter_default_permission_set')
    self.submitter_default_permission_set = attributes[:'submitter_default_permission_set']
  end

  if attributes.key?(:'eula')
    self.eula = attributes[:'eula']
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.key?(:'extract_text_only')
    self.extract_text_only = attributes[:'extract_text_only']
  end
end

Instance Attribute Details

#eula ⇒ Object

Returns the value of attribute eula.



35
36
37
 
# File 'lib/tca_client/models/submission_base.rb', line 35

def eula
  @eula
end

#extract_text_only ⇒ Object

(optional) indicates if the submission should be treated as a text only submission. A text only submission cannot generate full reports or be viewed in the viewer, but can use the index only endpoint to be indexed



40
41
42
 
# File 'lib/tca_client/models/submission_base.rb', line 40

def extract_text_only
  @extract_text_only
end

#id ⇒ Object

Submission id, optional field



18
19
20
 
# File 'lib/tca_client/models/submission_base.rb', line 18

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



37
38
39
 
# File 'lib/tca_client/models/submission_base.rb', line 37

def metadata
  @metadata
end

#owner ⇒ Object

ID of the owning user



21
22
23
 
# File 'lib/tca_client/models/submission_base.rb', line 21

def owner
  @owner
end

#owner_default_permission_set ⇒ Object

Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED



24
25
26
 
# File 'lib/tca_client/models/submission_base.rb', line 24

def owner_default_permission_set
  @owner_default_permission_set
end

#submitter ⇒ Object

(optional) ID of the submitting user, if different from the owning user



30
31
32
 
# File 'lib/tca_client/models/submission_base.rb', line 30

def submitter
  @submitter
end

#submitter_default_permission_set ⇒ Object

Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED



33
34
35
 
# File 'lib/tca_client/models/submission_base.rb', line 33

def submitter_default_permission_set
  @submitter_default_permission_set
end

#title ⇒ Object

the title of the submission



27
28
29
 
# File 'lib/tca_client/models/submission_base.rb', line 27

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/tca_client/models/submission_base.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'owner' => :'owner',
    :'owner_default_permission_set' => :'owner_default_permission_set',
    :'title' => :'title',
    :'submitter' => :'submitter',
    :'submitter_default_permission_set' => :'submitter_default_permission_set',
    :'eula' => :'eula',
    :'metadata' => :'metadata',
    :'extract_text_only' => :'extract_text_only'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



220
221
222
 
# File 'lib/tca_client/models/submission_base.rb', line 220

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/tca_client/models/submission_base.rb', line 95

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/tca_client/models/submission_base.rb', line 80

def self.openapi_types
  {
    :'id' => :'Object',
    :'owner' => :'Object',
    :'owner_default_permission_set' => :'Object',
    :'title' => :'Object',
    :'submitter' => :'Object',
    :'submitter_default_permission_set' => :'Object',
    :'eula' => :'Object',
    :'metadata' => :'Object',
    :'extract_text_only' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/tca_client/models/submission_base.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      owner == o.owner &&
      owner_default_permission_set == o.owner_default_permission_set &&
      title == o.title &&
      submitter == o.submitter &&
      submitter_default_permission_set == o.submitter_default_permission_set &&
      eula == o.eula &&
      metadata == o.metadata &&
      extract_text_only == o.extract_text_only
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
278
279
280
281
282
283
284
285
 
# File 'lib/tca_client/models/submission_base.rb', line 250

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
    TCAClient.const_get(type).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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/tca_client/models/submission_base.rb', line 319

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/tca_client/models/submission_base.rb', line 227

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


207
208
209
 
# File 'lib/tca_client/models/submission_base.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/tca_client/models/submission_base.rb', line 213

def hash
  [id, owner, owner_default_permission_set, title, submitter, submitter_default_permission_set, eula, metadata, extract_text_only].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



154
155
156
157
 
# File 'lib/tca_client/models/submission_base.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
 
# File 'lib/tca_client/models/submission_base.rb', line 295

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/tca_client/models/submission_base.rb', line 301

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/tca_client/models/submission_base.rb', line 289

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
 
# File 'lib/tca_client/models/submission_base.rb', line 161

def valid?
  owner_default_permission_set_validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
  return false unless owner_default_permission_set_validator.valid?(@owner_default_permission_set)
  submitter_default_permission_set_validator = EnumAttributeValidator.new('Object', ['INSTRUCTOR', 'LEARNER', 'EDITOR', 'USER', 'APPLICANT', 'ADMINISTRATOR', 'UNDEFINED'])
  return false unless submitter_default_permission_set_validator.valid?(@submitter_default_permission_set)
  true
end