Class: ProtonApi::VariableAnnuityRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/variable_annuity_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VariableAnnuityRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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
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/proton_api/models/variable_annuity_request.rb', line 161

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

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

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

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

  if attributes.has_key?(:'annuitization_rate')
    self.annuitization_rate = attributes[:'annuitization_rate']
  else
    self.annuitization_rate = 0.0
  end

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

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

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

  if attributes.has_key?(:'create_log')
    self.create_log = attributes[:'create_log']
  else
    self.create_log = false
  end

  if attributes.has_key?(:'inflation_rate')
    self.inflation_rate = attributes[:'inflation_rate']
  else
    self.inflation_rate = 0.0
  end

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

  if attributes.has_key?(:'n')
    self.n = attributes[:'n']
  else
    self.n = 1000
  end

  if attributes.has_key?(:'guaranteed_accumulation_benefit')
    self.guaranteed_accumulation_benefit = attributes[:'guaranteed_accumulation_benefit']
  else
    self.guaranteed_accumulation_benefit = 0.0
  end

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

  if attributes.has_key?(:'tax_rate')
    self.tax_rate = attributes[:'tax_rate']
  else
    self.tax_rate = 0.0
  end

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

  if attributes.has_key?(:'remove_outliers')
    self.remove_outliers = attributes[:'remove_outliers']
  else
    self.remove_outliers = false
  end

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

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

  if attributes.has_key?(:'result_type')
    self.result_type = attributes[:'result_type']
  else
    self.result_type = 'median'
  end

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

  if attributes.has_key?(:'trading_days_per_year')
    self.trading_days_per_year = attributes[:'trading_days_per_year']
  else
    self.trading_days_per_year = 252
  end

  if attributes.has_key?(:'use_proxy_data')
    self.use_proxy_data = attributes[:'use_proxy_data']
  else
    self.use_proxy_data = false
  end

  if attributes.has_key?(:'initial_balance')
    self.initial_balance = attributes[:'initial_balance']
  else
    self.initial_balance = 0.0
  end

  if attributes.has_key?(:'market_data_source')
    self.market_data_source = attributes[:'market_data_source']
  else
    self.market_data_source = 'nucleus'
  end

  if attributes.has_key?(:'frequency_interval')
    self.frequency_interval = attributes[:'frequency_interval']
  else
    self.frequency_interval = 'year'
  end

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

Instance Attribute Details

#account_idObject

Returns the value of attribute account_id.



57
58
59
# File 'lib/proton_api/models/variable_annuity_request.rb', line 57

def 
  @account_id
end

#accumulation_horizonObject

Returns the value of attribute accumulation_horizon.



23
24
25
# File 'lib/proton_api/models/variable_annuity_request.rb', line 23

def accumulation_horizon
  @accumulation_horizon
end

#aggregation_account_idObject

Returns the value of attribute aggregation_account_id.



37
38
39
# File 'lib/proton_api/models/variable_annuity_request.rb', line 37

def 
  @aggregation_account_id
end

#allocation_idObject

Returns the value of attribute allocation_id.



19
20
21
# File 'lib/proton_api/models/variable_annuity_request.rb', line 19

def allocation_id
  @allocation_id
end

#annuitization_rateObject

Returns the value of attribute annuitization_rate.



25
26
27
# File 'lib/proton_api/models/variable_annuity_request.rb', line 25

def annuitization_rate
  @annuitization_rate
end

#create_logObject

Returns the value of attribute create_log.



33
34
35
# File 'lib/proton_api/models/variable_annuity_request.rb', line 33

def create_log
  @create_log
end

#decumulation_horizonObject

Returns the value of attribute decumulation_horizon.



21
22
23
# File 'lib/proton_api/models/variable_annuity_request.rb', line 21

def decumulation_horizon
  @decumulation_horizon
end

#deposit_scheduleObject

Returns the value of attribute deposit_schedule.



69
70
71
# File 'lib/proton_api/models/variable_annuity_request.rb', line 69

def deposit_schedule
  @deposit_schedule
end

#end_dateObject

Returns the value of attribute end_date.



43
44
45
# File 'lib/proton_api/models/variable_annuity_request.rb', line 43

def end_date
  @end_date
end

#frequency_intervalObject

Returns the value of attribute frequency_interval.



67
68
69
# File 'lib/proton_api/models/variable_annuity_request.rb', line 67

def frequency_interval
  @frequency_interval
end

#guaranteed_accumulation_benefitObject

Returns the value of attribute guaranteed_accumulation_benefit.



41
42
43
# File 'lib/proton_api/models/variable_annuity_request.rb', line 41

def guaranteed_accumulation_benefit
  @guaranteed_accumulation_benefit
end

#guaranteed_rate_benefitObject

Returns the value of attribute guaranteed_rate_benefit.



27
28
29
# File 'lib/proton_api/models/variable_annuity_request.rb', line 27

def guaranteed_rate_benefit
  @guaranteed_rate_benefit
end

#inflation_rateObject

Returns the value of attribute inflation_rate.



35
36
37
# File 'lib/proton_api/models/variable_annuity_request.rb', line 35

def inflation_rate
  @inflation_rate
end

#initial_balanceObject

Returns the value of attribute initial_balance.



63
64
65
# File 'lib/proton_api/models/variable_annuity_request.rb', line 63

def initial_balance
  @initial_balance
end

#market_data_sourceObject

Returns the value of attribute market_data_source.



65
66
67
# File 'lib/proton_api/models/variable_annuity_request.rb', line 65

def market_data_source
  @market_data_source
end

#model_idObject

Returns the value of attribute model_id.



29
30
31
# File 'lib/proton_api/models/variable_annuity_request.rb', line 29

def model_id
  @model_id
end

#nObject

Returns the value of attribute n.



39
40
41
# File 'lib/proton_api/models/variable_annuity_request.rb', line 39

def n
  @n
end

#pObject

Returns the value of attribute p.



17
18
19
# File 'lib/proton_api/models/variable_annuity_request.rb', line 17

def p
  @p
end

#portfolio_idObject

Returns the value of attribute portfolio_id.



53
54
55
# File 'lib/proton_api/models/variable_annuity_request.rb', line 53

def portfolio_id
  @portfolio_id
end

#portfolio_tickersObject

Returns the value of attribute portfolio_tickers.



31
32
33
# File 'lib/proton_api/models/variable_annuity_request.rb', line 31

def portfolio_tickers
  @portfolio_tickers
end

#portfolio_weightsObject

Returns the value of attribute portfolio_weights.



51
52
53
# File 'lib/proton_api/models/variable_annuity_request.rb', line 51

def portfolio_weights
  @portfolio_weights
end

#remove_outliersObject

Returns the value of attribute remove_outliers.



49
50
51
# File 'lib/proton_api/models/variable_annuity_request.rb', line 49

def remove_outliers
  @remove_outliers
end

#result_typeObject

Returns the value of attribute result_type.



55
56
57
# File 'lib/proton_api/models/variable_annuity_request.rb', line 55

def result_type
  @result_type
end

#start_dateObject

Returns the value of attribute start_date.



47
48
49
# File 'lib/proton_api/models/variable_annuity_request.rb', line 47

def start_date
  @start_date
end

#tax_rateObject

Returns the value of attribute tax_rate.



45
46
47
# File 'lib/proton_api/models/variable_annuity_request.rb', line 45

def tax_rate
  @tax_rate
end

#trading_days_per_yearObject

Returns the value of attribute trading_days_per_year.



59
60
61
# File 'lib/proton_api/models/variable_annuity_request.rb', line 59

def trading_days_per_year
  @trading_days_per_year
end

#use_proxy_dataObject

Returns the value of attribute use_proxy_data.



61
62
63
# File 'lib/proton_api/models/variable_annuity_request.rb', line 61

def use_proxy_data
  @use_proxy_data
end

Class Method Details

.attribute_mapObject

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/proton_api/models/variable_annuity_request.rb', line 94

def self.attribute_map
  {
    :'p' => :'p',
    :'allocation_id' => :'allocation_id',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'accumulation_horizon' => :'accumulation_horizon',
    :'annuitization_rate' => :'annuitization_rate',
    :'guaranteed_rate_benefit' => :'guaranteed_rate_benefit',
    :'model_id' => :'model_id',
    :'portfolio_tickers' => :'portfolio_tickers',
    :'create_log' => :'create_log',
    :'inflation_rate' => :'inflation_rate',
    :'aggregation_account_id' => :'aggregation_account_id',
    :'n' => :'n',
    :'guaranteed_accumulation_benefit' => :'guaranteed_accumulation_benefit',
    :'end_date' => :'end_date',
    :'tax_rate' => :'tax_rate',
    :'start_date' => :'start_date',
    :'remove_outliers' => :'remove_outliers',
    :'portfolio_weights' => :'portfolio_weights',
    :'portfolio_id' => :'portfolio_id',
    :'result_type' => :'result_type',
    :'account_id' => :'account_id',
    :'trading_days_per_year' => :'trading_days_per_year',
    :'use_proxy_data' => :'use_proxy_data',
    :'initial_balance' => :'initial_balance',
    :'market_data_source' => :'market_data_source',
    :'frequency_interval' => :'frequency_interval',
    :'deposit_schedule' => :'deposit_schedule'
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/proton_api/models/variable_annuity_request.rb', line 127

def self.swagger_types
  {
    :'p' => :'Float',
    :'allocation_id' => :'String',
    :'decumulation_horizon' => :'Integer',
    :'accumulation_horizon' => :'Integer',
    :'annuitization_rate' => :'Float',
    :'guaranteed_rate_benefit' => :'Array<GuaranteedRateBenefit>',
    :'model_id' => :'String',
    :'portfolio_tickers' => :'Array<String>',
    :'create_log' => :'BOOLEAN',
    :'inflation_rate' => :'Float',
    :'aggregation_account_id' => :'String',
    :'n' => :'Integer',
    :'guaranteed_accumulation_benefit' => :'Float',
    :'end_date' => :'String',
    :'tax_rate' => :'Float',
    :'start_date' => :'String',
    :'remove_outliers' => :'BOOLEAN',
    :'portfolio_weights' => :'Array<Float>',
    :'portfolio_id' => :'String',
    :'result_type' => :'String',
    :'account_id' => :'String',
    :'trading_days_per_year' => :'Integer',
    :'use_proxy_data' => :'BOOLEAN',
    :'initial_balance' => :'Float',
    :'market_data_source' => :'String',
    :'frequency_interval' => :'String',
    :'deposit_schedule' => :'AnnuityDepositSchedule'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
# File 'lib/proton_api/models/variable_annuity_request.rb', line 554

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      p == o.p &&
      allocation_id == o.allocation_id &&
      decumulation_horizon == o.decumulation_horizon &&
      accumulation_horizon == o.accumulation_horizon &&
      annuitization_rate == o.annuitization_rate &&
      guaranteed_rate_benefit == o.guaranteed_rate_benefit &&
      model_id == o.model_id &&
      portfolio_tickers == o.portfolio_tickers &&
      create_log == o.create_log &&
      inflation_rate == o.inflation_rate &&
       == o. &&
      n == o.n &&
      guaranteed_accumulation_benefit == o.guaranteed_accumulation_benefit &&
      end_date == o.end_date &&
      tax_rate == o.tax_rate &&
      start_date == o.start_date &&
      remove_outliers == o.remove_outliers &&
      portfolio_weights == o.portfolio_weights &&
      portfolio_id == o.portfolio_id &&
      result_type == o.result_type &&
       == o. &&
      trading_days_per_year == o.trading_days_per_year &&
      use_proxy_data == o.use_proxy_data &&
      initial_balance == o.initial_balance &&
      market_data_source == o.market_data_source &&
      frequency_interval == o.frequency_interval &&
      deposit_schedule == o.deposit_schedule
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
# File 'lib/proton_api/models/variable_annuity_request.rb', line 621

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



685
686
687
688
689
690
691
692
693
694
695
696
697
# File 'lib/proton_api/models/variable_annuity_request.rb', line 685

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



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'lib/proton_api/models/variable_annuity_request.rb', line 601

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


588
589
590
# File 'lib/proton_api/models/variable_annuity_request.rb', line 588

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



594
595
596
# File 'lib/proton_api/models/variable_annuity_request.rb', line 594

def hash
  [p, allocation_id, decumulation_horizon, accumulation_horizon, annuitization_rate, guaranteed_rate_benefit, model_id, portfolio_tickers, create_log, inflation_rate, , n, guaranteed_accumulation_benefit, end_date, tax_rate, start_date, remove_outliers, portfolio_weights, portfolio_id, result_type, , trading_days_per_year, use_proxy_data, initial_balance, market_data_source, frequency_interval, deposit_schedule].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/proton_api/models/variable_annuity_request.rb', line 310

def list_invalid_properties
  invalid_properties = Array.new
  if !@p.nil? && @p > 100
    invalid_properties.push('invalid value for "p", must be smaller than or equal to 100.')
  end

  if !@p.nil? && @p < 0
    invalid_properties.push('invalid value for "p", must be greater than or equal to 0.')
  end

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

  if @decumulation_horizon < 1
    invalid_properties.push('invalid value for "decumulation_horizon", must be greater than or equal to 1.')
  end

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

  if @accumulation_horizon < 0
    invalid_properties.push('invalid value for "accumulation_horizon", must be greater than or equal to 0.')
  end

  if !@annuitization_rate.nil? && @annuitization_rate < -1
    invalid_properties.push('invalid value for "annuitization_rate", must be greater than or equal to -1.')
  end

  if !@inflation_rate.nil? && @inflation_rate > 20
    invalid_properties.push('invalid value for "inflation_rate", must be smaller than or equal to 20.')
  end

  if !@inflation_rate.nil? && @inflation_rate < -1
    invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
  end

  if !@n.nil? && @n < 1
    invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
  end

  if !@guaranteed_accumulation_benefit.nil? && @guaranteed_accumulation_benefit < 0
    invalid_properties.push('invalid value for "guaranteed_accumulation_benefit", must be greater than or equal to 0.')
  end

  if !@tax_rate.nil? && @tax_rate > 1
    invalid_properties.push('invalid value for "tax_rate", must be smaller than or equal to 1.')
  end

  if !@tax_rate.nil? && @tax_rate < 0
    invalid_properties.push('invalid value for "tax_rate", must be greater than or equal to 0.')
  end

  if !@trading_days_per_year.nil? && @trading_days_per_year < 1
    invalid_properties.push('invalid value for "trading_days_per_year", must be greater than or equal to 1.')
  end

  if !@initial_balance.nil? && @initial_balance < 0
    invalid_properties.push('invalid value for "initial_balance", must be greater than or equal to 0.')
  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



666
667
668
# File 'lib/proton_api/models/variable_annuity_request.rb', line 666

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



672
673
674
675
676
677
678
679
680
# File 'lib/proton_api/models/variable_annuity_request.rb', line 672

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 String presentation of the object.

Returns:

  • (String)

    String presentation of the object



660
661
662
# File 'lib/proton_api/models/variable_annuity_request.rb', line 660

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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'lib/proton_api/models/variable_annuity_request.rb', line 377

def valid?
  return false if !@p.nil? && @p > 100
  return false if !@p.nil? && @p < 0
  return false if @decumulation_horizon.nil?
  return false if @decumulation_horizon < 1
  return false if @accumulation_horizon.nil?
  return false if @accumulation_horizon < 0
  return false if !@annuitization_rate.nil? && @annuitization_rate < -1
  return false if !@inflation_rate.nil? && @inflation_rate > 20
  return false if !@inflation_rate.nil? && @inflation_rate < -1
  return false if !@n.nil? && @n < 1
  return false if !@guaranteed_accumulation_benefit.nil? && @guaranteed_accumulation_benefit < 0
  return false if !@tax_rate.nil? && @tax_rate > 1
  return false if !@tax_rate.nil? && @tax_rate < 0
  result_type_validator = EnumAttributeValidator.new('String', ['mean', 'median', 'custom'])
  return false unless result_type_validator.valid?(@result_type)
  return false if !@trading_days_per_year.nil? && @trading_days_per_year < 1
  return false if !@initial_balance.nil? && @initial_balance < 0
  market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
  return false unless market_data_source_validator.valid?(@market_data_source)
  frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  return false unless frequency_interval_validator.valid?(@frequency_interval)
  true
end