Class: PsiEligibility::CandidateModel

Inherits:
Object
  • Object
show all
Defined in:
lib/psi_eligibility/models/candidate_model.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CandidateModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/psi_eligibility/models/candidate_model.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_attributesObject

Returns the value of attribute additional_attributes.



53
54
55
# File 'lib/psi_eligibility/models/candidate_model.rb', line 53

def additional_attributes
  @additional_attributes
end

#address1Object

Returns the value of attribute address1.



28
29
30
# File 'lib/psi_eligibility/models/candidate_model.rb', line 28

def address1
  @address1
end

#address2Object

Returns the value of attribute address2.



24
25
26
# File 'lib/psi_eligibility/models/candidate_model.rb', line 24

def address2
  @address2
end

#candidate_idObject

The supplied candidates unique id.



42
43
44
# File 'lib/psi_eligibility/models/candidate_model.rb', line 42

def candidate_id
  @candidate_id
end

#cityObject

Returns the value of attribute city.



26
27
28
# File 'lib/psi_eligibility/models/candidate_model.rb', line 26

def city
  @city
end

#countryObject

Returns the value of attribute country.



17
18
19
# File 'lib/psi_eligibility/models/candidate_model.rb', line 17

def country
  @country
end

#emailObject

Returns the value of attribute email.



51
52
53
# File 'lib/psi_eligibility/models/candidate_model.rb', line 51

def email
  @email
end

#first_nameObject

Returns the value of attribute first_name.



49
50
51
# File 'lib/psi_eligibility/models/candidate_model.rb', line 49

def first_name
  @first_name
end

#home_phoneObject

Returns the value of attribute home_phone.



19
20
21
# File 'lib/psi_eligibility/models/candidate_model.rb', line 19

def home_phone
  @home_phone
end

#last_nameObject

Returns the value of attribute last_name.



33
34
35
# File 'lib/psi_eligibility/models/candidate_model.rb', line 33

def last_name
  @last_name
end

#middle_nameObject

Returns the value of attribute middle_name.



37
38
39
# File 'lib/psi_eligibility/models/candidate_model.rb', line 37

def middle_name
  @middle_name
end

#office_phoneObject

Returns the value of attribute office_phone.



44
45
46
# File 'lib/psi_eligibility/models/candidate_model.rb', line 44

def office_phone
  @office_phone
end

#postal_codeObject

Candidates zip code, postal code or equivilent.



47
48
49
# File 'lib/psi_eligibility/models/candidate_model.rb', line 47

def postal_code
  @postal_code
end

#province_stateObject

The canidates province, state or equivilent.



31
32
33
# File 'lib/psi_eligibility/models/candidate_model.rb', line 31

def province_state
  @province_state
end

#school_codeObject

If supplied, the list of school codes must be added to PSI’s system in advance of the import.



22
23
24
# File 'lib/psi_eligibility/models/candidate_model.rb', line 22

def school_code
  @school_code
end

#special_accommodationsObject

Returns the value of attribute special_accommodations.



39
40
41
# File 'lib/psi_eligibility/models/candidate_model.rb', line 39

def special_accommodations
  @special_accommodations
end

#suffixObject

Returns the value of attribute suffix.



35
36
37
# File 'lib/psi_eligibility/models/candidate_model.rb', line 35

def suffix
  @suffix
end

Class Method Details

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/psi_eligibility/models/candidate_model.rb', line 56

def self.attribute_map
  {
    :'country' => :'country',
    :'home_phone' => :'home_phone',
    :'school_code' => :'school_code',
    :'address2' => :'address2',
    :'city' => :'city',
    :'address1' => :'address1',
    :'province_state' => :'province_state',
    :'last_name' => :'last_name',
    :'suffix' => :'suffix',
    :'middle_name' => :'middle_name',
    :'special_accommodations' => :'special_accommodations',
    :'candidate_id' => :'candidate_id',
    :'office_phone' => :'office_phone',
    :'postal_code' => :'postal_code',
    :'first_name' => :'first_name',
    :'email' => :'email',
    :'additional_attributes' => :'additional_attributes'
  }
end

.swagger_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/psi_eligibility/models/candidate_model.rb', line 79

def self.swagger_types
  {
    :'country' => :'String',
    :'home_phone' => :'String',
    :'school_code' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'address1' => :'String',
    :'province_state' => :'String',
    :'last_name' => :'String',
    :'suffix' => :'String',
    :'middle_name' => :'String',
    :'special_accommodations' => :'Array<String>',
    :'candidate_id' => :'String',
    :'office_phone' => :'String',
    :'postal_code' => :'String',
    :'first_name' => :'String',
    :'email' => :'String',
    :'additional_attributes' => :'Array<AdditionalAttributeModel>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/psi_eligibility/models/candidate_model.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      country == o.country &&
      home_phone == o.home_phone &&
      school_code == o.school_code &&
      address2 == o.address2 &&
      city == o.city &&
      address1 == o.address1 &&
      province_state == o.province_state &&
      last_name == o.last_name &&
      suffix == o.suffix &&
      middle_name == o.middle_name &&
      special_accommodations == o.special_accommodations &&
      candidate_id == o.candidate_id &&
      office_phone == o.office_phone &&
      postal_code == o.postal_code &&
      first_name == o.first_name &&
      email == o.email &&
      additional_attributes == o.additional_attributes
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/psi_eligibility/models/candidate_model.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'lib/psi_eligibility/models/candidate_model.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/psi_eligibility/models/candidate_model.rb', line 249

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


236
237
238
# File 'lib/psi_eligibility/models/candidate_model.rb', line 236

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



242
243
244
# File 'lib/psi_eligibility/models/candidate_model.rb', line 242

def hash
  [country, home_phone, school_code, address2, city, address1, province_state, last_name, suffix, middle_name, special_accommodations, candidate_id, office_phone, postal_code, first_name, email, additional_attributes].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/psi_eligibility/models/candidate_model.rb', line 184

def list_invalid_properties
  invalid_properties = Array.new
  if @last_name.nil?
    invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
  end

  if @candidate_id.nil?
    invalid_properties.push('invalid value for "candidate_id", candidate_id cannot be nil.')
  end

  if @first_name.nil?
    invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



316
317
318
# File 'lib/psi_eligibility/models/candidate_model.rb', line 316

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
# File 'lib/psi_eligibility/models/candidate_model.rb', line 322

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



310
311
312
# File 'lib/psi_eligibility/models/candidate_model.rb', line 310

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



203
204
205
206
207
208
# File 'lib/psi_eligibility/models/candidate_model.rb', line 203

def valid?
  return false if @last_name.nil?
  return false if @candidate_id.nil?
  return false if @first_name.nil?
  true
end