Class: PsiEligibility::ExistingEligibilityModel

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

Overview

An existing eligibility record.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExistingEligibilityModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#candidate ⇒ Object

Returns the value of attribute candidate.



21
22
23
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 21

def candidate
  @candidate
end

#client_eligibility_id ⇒ Object

Client’s unique identifier for this eligibility if provided.



45
46
47
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 45

def client_eligibility_id
  @client_eligibility_id
end

#created_datetime ⇒ Object

Datetime when the eligibility was created. ISO 8601 format similar to Java ISO_OFFSET_DATE_TIME format.



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

def created_datetime
  @created_datetime
end

#eligibility_end_date ⇒ Object

The last date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format.



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

def eligibility_end_date
  @eligibility_end_date
end

#eligibility_status_message ⇒ Object

Any pertinent message about why a candidate is not eligibile to scheduled yet. Common reasons can be because they have been blocked, have pending special accommodations or other similar reasons. Will be null if candidate is eligible to schedule.



30
31
32
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 30

def eligibility_status_message
  @eligibility_status_message
end

#eligible_to_schedule ⇒ Object

Whether or not this candidate is eligibile to be scheduled.



36
37
38
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 36

def eligible_to_schedule
  @eligible_to_schedule
end

#portion_codes ⇒ Object

If required, specific portion codes may be supplied.



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

def portion_codes
  @portion_codes
end

#psi_eligiblity_id ⇒ Object

PSI’s unique identifier for this eligibility.



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

def psi_eligiblity_id
  @psi_eligiblity_id
end

#schedule_start_date ⇒ Object

The first date possible for the candidate to schedule on. Java ISO_OFFSET_DATE_TIME format.



27
28
29
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 27

def schedule_start_date
  @schedule_start_date
end

#status ⇒ Object

Only set on this object when returned back to client. Setting this has no effect when provided as part of a create or update. This is the 4 different eligibility statuses available for a candidate: REG01 is Registration Pending, REG02 is Registration approved, REG03 is Cancelled, REG04 is Scheduled



48
49
50
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 48

def status
  @status
end

#test_code ⇒ Object

The client specific test code for the eligibility to be created against.



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

def test_code
  @test_code
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 73

def self.attribute_map
  {
    :'eligibility_end_date' => :'eligibility_end_date',
    :'candidate' => :'candidate',
    :'portion_codes' => :'portion_codes',
    :'schedule_start_date' => :'schedule_start_date',
    :'eligibility_status_message' => :'eligibility_status_message',
    :'test_code' => :'test_code',
    :'eligible_to_schedule' => :'eligible_to_schedule',
    :'psi_eligiblity_id' => :'psi_eligiblity_id',
    :'created_datetime' => :'created_datetime',
    :'client_eligibility_id' => :'client_eligibility_id',
    :'status' => :'status'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 90

def self.swagger_types
  {
    :'eligibility_end_date' => :'String',
    :'candidate' => :'CandidateModel',
    :'portion_codes' => :'Array<String>',
    :'schedule_start_date' => :'String',
    :'eligibility_status_message' => :'String',
    :'test_code' => :'String',
    :'eligible_to_schedule' => :'BOOLEAN',
    :'psi_eligiblity_id' => :'String',
    :'created_datetime' => :'String',
    :'client_eligibility_id' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      eligibility_end_date == o.eligibility_end_date &&
      candidate == o.candidate &&
      portion_codes == o.portion_codes &&
      schedule_start_date == o.schedule_start_date &&
      eligibility_status_message == o.eligibility_status_message &&
      test_code == o.test_code &&
      eligible_to_schedule == o.eligible_to_schedule &&
      psi_eligiblity_id == o.psi_eligiblity_id &&
      created_datetime == o.created_datetime &&
      client_eligibility_id == o.client_eligibility_id &&
      status == o.status
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



240
241
242
243
244
245
246
247
248
249
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
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 240

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 306

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 219

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


206
207
208
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 212

def hash
  [eligibility_end_date, candidate, portion_codes, schedule_start_date, eligibility_status_message, test_code, eligible_to_schedule, psi_eligiblity_id, created_datetime, client_eligibility_id, status].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



163
164
165
166
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 163

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



286
287
288
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 292

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



280
281
282
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 280

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



170
171
172
173
174
 
# File 'lib/psi_eligibility/models/existing_eligibility_model.rb', line 170

def valid?
  status_validator = EnumAttributeValidator.new('String', ['REG01', 'REG02', 'REG03', 'REG04'])
  return false unless status_validator.valid?(@status)
  true
end