Class: Comet::ScheduleConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/schedule_config.rb

Overview

ScheduleConfig is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScheduleConfig

Returns a new instance of ScheduleConfig.



44
45
46
 
# File 'lib/comet/models/schedule_config.rb', line 44

def initialize
  clear
end

Instance Attribute Details

#days_select ⇒ Object

Returns the value of attribute days_select.



39
40
41
 
# File 'lib/comet/models/schedule_config.rb', line 39

def days_select
  @days_select
end

#frequency_type ⇒ Object

Returns the value of attribute frequency_type.



18
19
20
 
# File 'lib/comet/models/schedule_config.rb', line 18

def frequency_type
  @frequency_type
end

#from_time ⇒ Object

Returns the value of attribute from_time.



30
31
32
 
# File 'lib/comet/models/schedule_config.rb', line 30

def from_time
  @from_time
end

#offset ⇒ Object

Returns the value of attribute offset.



24
25
26
 
# File 'lib/comet/models/schedule_config.rb', line 24

def offset
  @offset
end

#restrict_days ⇒ Object

Returns the value of attribute restrict_days.



36
37
38
 
# File 'lib/comet/models/schedule_config.rb', line 36

def restrict_days
  @restrict_days
end

#restrict_runtime ⇒ Object

Returns the value of attribute restrict_runtime.



27
28
29
 
# File 'lib/comet/models/schedule_config.rb', line 27

def restrict_runtime
  @restrict_runtime
end

#seconds_past ⇒ Object

Returns the value of attribute seconds_past.



21
22
23
 
# File 'lib/comet/models/schedule_config.rb', line 21

def seconds_past
  @seconds_past
end

#to_time ⇒ Object

Returns the value of attribute to_time.



33
34
35
 
# File 'lib/comet/models/schedule_config.rb', line 33

def to_time
  @to_time
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



42
43
44
 
# File 'lib/comet/models/schedule_config.rb', line 42

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/comet/models/schedule_config.rb', line 48

def clear
  @frequency_type = 0
  @seconds_past = 0
  @offset = 0
  @from_time = Comet::HourSchedConfig.new
  @to_time = Comet::HourSchedConfig.new
  @days_select = Comet::DaysOfWeekConfig.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


66
67
68
69
70
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
 
# File 'lib/comet/models/schedule_config.rb', line 66

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'FrequencyType'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @frequency_type = v
    when 'SecondsPast'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @seconds_past = v
    when 'Offset'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @offset = v
    when 'RestrictRuntime'
      @restrict_runtime = v
    when 'FromTime'
      @from_time = Comet::HourSchedConfig.new
      @from_time.from_hash(v)
    when 'ToTime'
      @to_time = Comet::HourSchedConfig.new
      @to_time.from_hash(v)
    when 'RestrictDays'
      @restrict_days = v
    when 'DaysSelect'
      @days_select = Comet::DaysOfWeekConfig.new
      @days_select.from_hash(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


59
60
61
62
63
 
# File 'lib/comet/models/schedule_config.rb', line 59

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



122
123
124
 
# File 'lib/comet/models/schedule_config.rb', line 122

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/comet/models/schedule_config.rb', line 103

def to_hash
  ret = {}
  ret['FrequencyType'] = @frequency_type
  ret['SecondsPast'] = @seconds_past
  unless @offset.nil?
    ret['Offset'] = @offset
  end
  ret['RestrictRuntime'] = @restrict_runtime
  ret['FromTime'] = @from_time
  ret['ToTime'] = @to_time
  ret['RestrictDays'] = @restrict_days
  ret['DaysSelect'] = @days_select
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



127
128
129
 
# File 'lib/comet/models/schedule_config.rb', line 127

def to_json(options = {})
  to_hash.to_json(options)
end