Class: RusticiSoftwareCloudV2::SettingMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/models/setting_metadata.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SettingMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
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
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 71

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?(:'default')
    self.default = attributes[:'default']
  end

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

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

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

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

  if attributes.has_key?(:'learningStandardVariant')
    self.learning_standard_variant = attributes[:'learningStandardVariant']
  else
    self.learning_standard_variant = 'either'
  end

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

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

Instance Attribute Details

#data_type ⇒ Object

The data type of this setting



21
22
23
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 21

def data_type
  @data_type
end

#default ⇒ Object

Default value of this setting



18
19
20
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 18

def default
  @default
end

#fallback ⇒ Object

A setting that will be used instead of this setting if no value is provided for this setting (This is similar to a default, except that the the value of another setting is being used instead of a fixed default value).



36
37
38
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 36

def fallback
  @fallback
end

#learning_standard_variant ⇒ Object

Does this setting apply to only single-SCO packages, only multi-SCO, or either?



33
34
35
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 33

def learning_standard_variant
  @learning_standard_variant
end

#learning_standards ⇒ Object

The list of learning standards this setting applies to. If not present, this setting is not limited to certain learning standards.



30
31
32
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 30

def learning_standards
  @learning_standards
end

#level ⇒ Object

The level this setting will be applied at, which limits where it can be set. For example, WebPathToContentRoot is applied at the application level, so it’s not valid to set it for a registration.



27
28
29
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 27

def level
  @level
end

#setting_description ⇒ Object

description of this setting



24
25
26
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 24

def setting_description
  @setting_description
end

#valid_values ⇒ Object

For settings with a fixed list of valid values, the list of those values



39
40
41
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 39

def valid_values
  @valid_values
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 42

def self.attribute_map
  {
    :'default' => :'default',
    :'data_type' => :'dataType',
    :'setting_description' => :'settingDescription',
    :'level' => :'level',
    :'learning_standards' => :'learningStandards',
    :'learning_standard_variant' => :'learningStandardVariant',
    :'fallback' => :'fallback',
    :'valid_values' => :'validValues'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 56

def self.swagger_types
  {
    :'default' => :'String',
    :'data_type' => :'String',
    :'setting_description' => :'String',
    :'level' => :'String',
    :'learning_standards' => :'Array<String>',
    :'learning_standard_variant' => :'String',
    :'fallback' => :'String',
    :'valid_values' => :'Array<SettingValidValue>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default == o.default &&
      data_type == o.data_type &&
      setting_description == o.setting_description &&
      level == o.level &&
      learning_standards == o.learning_standards &&
      learning_standard_variant == o.learning_standard_variant &&
      fallback == o.fallback &&
      valid_values == o.valid_values
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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 189

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 = RusticiSoftwareCloudV2.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 255

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 168

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 161

def hash
  [default, data_type, setting_description, level, learning_standards, learning_standard_variant, fallback, valid_values].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



118
119
120
121
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 118

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



235
236
237
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 235

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 241

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

Returns:

  • (String) —

    String presentation of the object



229
230
231
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 229

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



125
126
127
 
# File 'lib/rustici_software_cloud_v2/models/setting_metadata.rb', line 125

def valid?
  true
end