Class: EdmentumClient::EdApiModelsProgram

Inherits:
Object
  • Object
show all
Defined in:
lib/edmentum_client/models/ed_api_models_program.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EdApiModelsProgram

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 77

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

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

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

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

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

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

Instance Attribute Details

#access_type ⇒ Object

Returns the value of attribute access_type.



23
24
25
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 23

def access_type
  @access_type
end

#application ⇒ Object

Returns the value of attribute application.



21
22
23
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 21

def application
  @application
end

#is_eoa_program ⇒ Object

Returns the value of attribute is_eoa_program.



27
28
29
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 27

def is_eoa_program
  @is_eoa_program
end

#locations ⇒ Object

Returns the value of attribute locations.



25
26
27
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 25

def locations
  @locations
end

#program_id ⇒ Object

Returns the value of attribute program_id.



17
18
19
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 17

def program_id
  @program_id
end

#program_title ⇒ Object

Returns the value of attribute program_title.



19
20
21
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 19

def program_title
  @program_title
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 52

def self.attribute_map
  {
    :'program_id' => :'ProgramId',
    :'program_title' => :'ProgramTitle',
    :'application' => :'Application',
    :'access_type' => :'AccessType',
    :'locations' => :'Locations',
    :'is_eoa_program' => :'IsEOAProgram'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 64

def self.swagger_types
  {
    :'program_id' => :'Integer',
    :'program_title' => :'String',
    :'application' => :'Integer',
    :'access_type' => :'String',
    :'locations' => :'Array<EdApiModelsLocation>',
    :'is_eoa_program' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      program_id == o.program_id &&
      program_title == o.program_title &&
      application == o.application &&
      access_type == o.access_type &&
      locations == o.locations &&
      is_eoa_program == o.is_eoa_program
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



184
185
186
187
188
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
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 184

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 250

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 163

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


150
151
152
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 156

def hash
  [program_id, program_title, application, access_type, locations, is_eoa_program].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



112
113
114
115
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 112

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



230
231
232
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 230

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



236
237
238
239
240
241
242
243
244
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 236

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



224
225
226
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 224

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



119
120
121
122
123
 
# File 'lib/edmentum_client/models/ed_api_models_program.rb', line 119

def valid?
  application_validator = EnumAttributeValidator.new('Integer', ['0', '3', '4', '8', '9', '12', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '27', '29', '30', '31', '32'])
  return false unless application_validator.valid?(@application)
  true
end