Module: RiCal::Properties::TimezonePeriod

Included in:
Component::Timezone::TimezonePeriod
Defined in:
lib/ri_cal/properties/timezone_period.rb

Overview

Properties::TimezonePeriod provides property accessing methods for the TimezonePeriod class This source file is generated by the rical:gen_propmodules rake tasks, DO NOT EDIT

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(mod) ⇒ Object

:nodoc:



404
405
406
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 404

def self.included(mod) #:nodoc:
  mod.extend ClassMethods
end

Instance Method Details

#==(o) ⇒ Object

:nodoc:



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 368

def ==(o) #:nodoc:
  if o.class == self.class
  (rdate_property == o.rdate_property) &&
  (tzoffsetto_property == o.tzoffsetto_property) &&
  (dtstart_property == o.dtstart_property) &&
  (tzname_property == o.tzname_property) &&
  (tzoffsetfrom_property == o.tzoffsetfrom_property) &&
  (rrule_property == o.rrule_property) &&
  (comment_property == o.comment_property)
  else
     super
  end
end

#add_comment(ruby_value) ⇒ Object

add one value to the COMMENT property one instances of String may be passed to this method



143
144
145
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 143

def  add_comment(ruby_value)
 self.comment_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#add_comments(*ruby_values) ⇒ Object

add one or more values to the COMMENT property one or more instances of String may be passed to this method



137
138
139
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 137

def  add_comments(*ruby_values)
 ruby_values.each {|val|  self.comment_property << RiCal::PropertyValue::Text.convert(self, val)}
end

#add_date_times_to(required_timezones) ⇒ Object

:nodoc:



393
394
395
396
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 393

def add_date_times_to(required_timezones) #:nodoc:
  add_property_date_times_to(required_timezones, dtstart_property)
  add_property_date_times_to(required_timezones, rdate_property)
end

#add_rdate(*ruby_value) ⇒ Object

add one value to the RDATE property one instances of OccurrenceList may be passed to this method



206
207
208
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 206

def  add_rdate(*ruby_value)
 self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)
end

#add_rdates(*ruby_values) ⇒ Object

add one or more values to the RDATE property one or more instances of OccurrenceList may be passed to this method



200
201
202
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 200

def  add_rdates(*ruby_values)
 ruby_values.each {|val|  self.rdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *val)}
end

#add_rrule(ruby_value) ⇒ Object

add one value to the RRULE property one instances of RecurrenceRule may be passed to this method



269
270
271
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 269

def  add_rrule(ruby_value)
 self.rrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)
end

#add_rrules(*ruby_values) ⇒ Object

add one or more values to the RRULE property one or more instances of RecurrenceRule may be passed to this method



263
264
265
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 263

def  add_rrules(*ruby_values)
 ruby_values.each {|val|  self.rrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, val)}
end

#add_tzname(ruby_value) ⇒ Object

add one value to the TZNAME property one instances of String may be passed to this method



332
333
334
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 332

def  add_tzname(ruby_value)
 self.tzname_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#add_tznames(*ruby_values) ⇒ Object

add one or more values to the TZNAME property one or more instances of String may be passed to this method



326
327
328
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 326

def  add_tznames(*ruby_values)
 ruby_values.each {|val|  self.tzname_property << RiCal::PropertyValue::Text.convert(self, val)}
end

#comment ⇒ Object

return the value of the COMMENT property which will be an array of instances of String



161
162
163
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 161

def comment
  comment_property.map {|prop| prop ? prop.ruby_value : prop}
end

#comment=(ruby_value) ⇒ Object

set the value of the COMMENT property to a single value one instance of String may be passed to this method



131
132
133
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 131

def comment=(ruby_value)
  @comment_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)]
end

#comment_property ⇒ Object

return the the COMMENT property which will be an array of instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property specifies non-processing information intended to provide a comment to the calendar user.

see RFC 2445 4.8.1.4 pp 80-81



113
114
115
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 113

def comment_property
  @comment_property ||= []
end

#comment_property=(*property_values) ⇒ Object

set the the COMMENT property one or more instances of RiCal::PropertyValueText may be passed to this method



119
120
121
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 119

def comment_property=(*property_values)
  @comment_property= property_values
end

#comment_property_from_string(line) ⇒ Object

:nodoc:



165
166
167
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 165

def comment_property_from_string(line) # :nodoc:
  comment_property << RiCal::PropertyValue::Text.new(self, line)
end

#comments=(ruby_values) ⇒ Object

set the value of the COMMENT property to multiple values one or more instances of String may be passed to this method



125
126
127
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 125

def comments=(ruby_values)
  @comment_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
end

#dtstart ⇒ Object

return the value of the DTSTART property which will be an instance of either DateTime or Date



31
32
33
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 31

def dtstart
  dtstart_property ? dtstart_property.ruby_value : nil
end

#dtstart=(ruby_value) ⇒ Object

set the value of the DTSTART property



25
26
27
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 25

def dtstart=(ruby_value)
  self.dtstart_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value)
end

#dtstart_property ⇒ Object

return the the DTSTART property which will be an instances of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date

purpose (from RFC 2445)

This property specifies when the calendar component begins.

see RFC 2445 4.8.2.4 pp 93-94



14
15
16
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 14

def dtstart_property
  @dtstart_property
end

#dtstart_property=(property_value) ⇒ Object

set the DTSTART property property value should be an instance of either RiCal::PropertyValue::DateTime or RiCal::PropertyValue::Date



20
21
22
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 20

def dtstart_property=(property_value)
  @dtstart_property = property_value ? property_value.for_parent(self) : nil
end

#dtstart_property_from_string(line) ⇒ Object

:nodoc:



35
36
37
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 35

def dtstart_property_from_string(line) # :nodoc:
  @dtstart_property = RiCal::PropertyValue::DateTime.or_date(self, line)
end

#export_properties_to(export_stream) ⇒ Object

:nodoc:



358
359
360
361
362
363
364
365
366
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 358

def export_properties_to(export_stream) #:nodoc:
  export_prop_to(export_stream, "RDATE", @rdate_property)
  export_prop_to(export_stream, "TZOFFSETTO", @tzoffsetto_property)
  export_prop_to(export_stream, "DTSTART", @dtstart_property)
  export_prop_to(export_stream, "TZNAME", @tzname_property)
  export_prop_to(export_stream, "TZOFFSETFROM", @tzoffsetfrom_property)
  export_prop_to(export_stream, "RRULE", @rrule_property)
  export_prop_to(export_stream, "COMMENT", @comment_property)
end

#initialize_copy(o) ⇒ Object

:nodoc:



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 382

def initialize_copy(o) #:nodoc:
  super
  rdate_property = rdate_property && rdate_property.dup
  tzoffsetto_property = tzoffsetto_property && tzoffsetto_property.dup
  dtstart_property = dtstart_property && dtstart_property.dup
  tzname_property = tzname_property && tzname_property.dup
  tzoffsetfrom_property = tzoffsetfrom_property && tzoffsetfrom_property.dup
  rrule_property = rrule_property && rrule_property.dup
  comment_property = comment_property && comment_property.dup
end

#mutual_exclusion_violation ⇒ Object

:nodoc:



408
409
410
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 408

def mutual_exclusion_violation #:nodoc:
  false
end

#rdate ⇒ Object

return the value of the RDATE property which will be an array of instances of OccurrenceList



224
225
226
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 224

def rdate
  rdate_property.map {|prop| prop ? prop.ruby_value : prop}
end

#rdate=(*ruby_value) ⇒ Object

set the value of the RDATE property to a single value one instance of OccurrenceList may be passed to this method



194
195
196
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 194

def rdate=(*ruby_value)
  @rdate_property = [RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)]
end

#rdate_property ⇒ Object

return the the RDATE property which will be an array of instances of RiCal::PropertyValueOccurrenceList

purpose (from RFC 2445)

This property defines the list of date/times for a recurring calendar component.

see RFC 2445 4.8.5.3 pp 115-117



176
177
178
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 176

def rdate_property
  @rdate_property ||= []
end

#rdate_property=(*property_values) ⇒ Object

set the the RDATE property one or more instances of RiCal::PropertyValueOccurrenceList may be passed to this method



182
183
184
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 182

def rdate_property=(*property_values)
  @rdate_property= property_values.map{|prop| prop.for_parent(self)}
end

#rdate_property_from_string(line) ⇒ Object

:nodoc:



228
229
230
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 228

def rdate_property_from_string(line) # :nodoc:
  rdate_property << RiCal::PropertyValue::OccurrenceList.new(self, line)
end

#rdates=(ruby_values) ⇒ Object

set the value of the RDATE property to multiple values one or more instances of OccurrenceList may be passed to this method



188
189
190
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 188

def rdates=(ruby_values)
  @rdate_property = ruby_values.map {|val| RiCal::PropertyValue::OccurrenceList.convert(self, *val)}
end

#remove_comment(ruby_value) ⇒ Object

remove one value from the COMMENT property one instances of String may be passed to this method



155
156
157
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 155

def  remove_comment(ruby_value)
 self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
end

#remove_comments(*ruby_values) ⇒ Object

remove one or more values from the COMMENT property one or more instances of String may be passed to this method



149
150
151
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 149

def  remove_comments(*ruby_values)
 ruby_values.each {|val|  self.comment_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
end

#remove_rdate(*ruby_value) ⇒ Object

remove one value from the RDATE property one instances of OccurrenceList may be passed to this method



218
219
220
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 218

def  remove_rdate(*ruby_value)
 self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value))
end

#remove_rdates(*ruby_values) ⇒ Object

remove one or more values from the RDATE property one or more instances of OccurrenceList may be passed to this method



212
213
214
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 212

def  remove_rdates(*ruby_values)
 ruby_values.each {|val|  self.rdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *val))}
end

#remove_rrule(ruby_value) ⇒ Object

remove one value from the RRULE property one instances of RecurrenceRule may be passed to this method



281
282
283
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 281

def  remove_rrule(ruby_value)
 self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value))
end

#remove_rrules(*ruby_values) ⇒ Object

remove one or more values from the RRULE property one or more instances of RecurrenceRule may be passed to this method



275
276
277
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 275

def  remove_rrules(*ruby_values)
 ruby_values.each {|val|  self.rrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, val))}
end

#remove_tzname(ruby_value) ⇒ Object

remove one value from the TZNAME property one instances of String may be passed to this method



344
345
346
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 344

def  remove_tzname(ruby_value)
 self.tzname_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
end

#remove_tznames(*ruby_values) ⇒ Object

remove one or more values from the TZNAME property one or more instances of String may be passed to this method



338
339
340
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 338

def  remove_tznames(*ruby_values)
 ruby_values.each {|val|  self.tzname_property.delete(RiCal::PropertyValue::Text.convert(self, val))}
end

#rrule ⇒ Object

return the value of the RRULE property which will be an array of instances of RecurrenceRule



287
288
289
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 287

def rrule
  rrule_property.map {|prop| prop ? prop.ruby_value : prop}
end

#rrule=(ruby_value) ⇒ Object

set the value of the RRULE property to a single value one instance of RecurrenceRule may be passed to this method



257
258
259
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 257

def rrule=(ruby_value)
  @rrule_property = [RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)]
end

#rrule_property ⇒ Object

return the the RRULE property which will be an array of instances of RiCal::PropertyValueRecurrenceRule

purpose (from RFC 2445)

This property defines a rule or repeating pattern for recurring events, to-dos, or time zone definitions.

see RFC 2445 4.8.5.4 pp 117-125



239
240
241
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 239

def rrule_property
  @rrule_property ||= []
end

#rrule_property=(*property_values) ⇒ Object

set the the RRULE property one or more instances of RiCal::PropertyValueRecurrenceRule may be passed to this method



245
246
247
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 245

def rrule_property=(*property_values)
  @rrule_property= property_values
end

#rrule_property_from_string(line) ⇒ Object

:nodoc:



291
292
293
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 291

def rrule_property_from_string(line) # :nodoc:
  rrule_property << RiCal::PropertyValue::RecurrenceRule.new(self, line)
end

#rrules=(ruby_values) ⇒ Object

set the value of the RRULE property to multiple values one or more instances of RecurrenceRule may be passed to this method



251
252
253
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 251

def rrules=(ruby_values)
  @rrule_property = ruby_values.map {|val| RiCal::PropertyValue::RecurrenceRule.convert(self, val)}
end

#tzname ⇒ Object

return the value of the TZNAME property which will be an array of instances of String



350
351
352
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 350

def tzname
  tzname_property.map {|prop| prop ? prop.ruby_value : prop}
end

#tzname=(ruby_value) ⇒ Object

set the value of the TZNAME property to a single value one instance of String may be passed to this method



320
321
322
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 320

def tzname=(ruby_value)
  @tzname_property = [RiCal::PropertyValue::Text.convert(self, ruby_value)]
end

#tzname_property ⇒ Object

return the the TZNAME property which will be an array of instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property specifies the customary designation for a time zone description.

see RFC 2445 4.8.3.2 p 99



302
303
304
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 302

def tzname_property
  @tzname_property ||= []
end

#tzname_property=(*property_values) ⇒ Object

set the the TZNAME property one or more instances of RiCal::PropertyValueText may be passed to this method



308
309
310
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 308

def tzname_property=(*property_values)
  @tzname_property= property_values
end

#tzname_property_from_string(line) ⇒ Object

:nodoc:



354
355
356
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 354

def tzname_property_from_string(line) # :nodoc:
  tzname_property << RiCal::PropertyValue::Text.new(self, line)
end

#tznames=(ruby_values) ⇒ Object

set the value of the TZNAME property to multiple values one or more instances of String may be passed to this method



314
315
316
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 314

def tznames=(ruby_values)
  @tzname_property = ruby_values.map {|val| RiCal::PropertyValue::Text.convert(self, val)}
end

#tzoffsetfrom ⇒ Object

return the value of the TZOFFSETFROM property which will be an instance of UtcOffset



97
98
99
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 97

def tzoffsetfrom
  tzoffsetfrom_property ? tzoffsetfrom_property.ruby_value : nil
end

#tzoffsetfrom=(ruby_value) ⇒ Object

set the value of the TZOFFSETFROM property



91
92
93
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 91

def tzoffsetfrom=(ruby_value)
  self.tzoffsetfrom_property= RiCal::PropertyValue::UtcOffset.convert(self, ruby_value)
end

#tzoffsetfrom_property ⇒ Object

return the the TZOFFSETFROM property which will be an instances of RiCal::PropertyValueUtcOffset

purpose (from RFC 2445)

This property specifies the offset which is in use prior to this time zone observance

see RFC 2445 4.8.3.3 pp 99-100



80
81
82
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 80

def tzoffsetfrom_property
  @tzoffsetfrom_property
end

#tzoffsetfrom_property=(property_value) ⇒ Object

set the TZOFFSETFROM property property value should be an instance of RiCal::PropertyValueUtcOffset



86
87
88
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 86

def tzoffsetfrom_property=(property_value)
  @tzoffsetfrom_property = property_value
end

#tzoffsetfrom_property_from_string(line) ⇒ Object

:nodoc:



101
102
103
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 101

def tzoffsetfrom_property_from_string(line) # :nodoc:
  @tzoffsetfrom_property = RiCal::PropertyValue::UtcOffset.new(self, line)
end

#tzoffsetto ⇒ Object

return the value of the TZOFFSETTO property which will be an instance of UtcOffset



64
65
66
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 64

def tzoffsetto
  tzoffsetto_property ? tzoffsetto_property.ruby_value : nil
end

#tzoffsetto=(ruby_value) ⇒ Object

set the value of the TZOFFSETTO property



58
59
60
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 58

def tzoffsetto=(ruby_value)
  self.tzoffsetto_property= RiCal::PropertyValue::UtcOffset.convert(self, ruby_value)
end

#tzoffsetto_property ⇒ Object

return the the TZOFFSETTO property which will be an instances of RiCal::PropertyValueUtcOffset

purpose (from RFC 2445)

This property specifies the offset which is in use in this time zone observance

see RFC 2445 4.8.3.4 pp 100-101



47
48
49
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 47

def tzoffsetto_property
  @tzoffsetto_property
end

#tzoffsetto_property=(property_value) ⇒ Object

set the TZOFFSETTO property property value should be an instance of RiCal::PropertyValueUtcOffset



53
54
55
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 53

def tzoffsetto_property=(property_value)
  @tzoffsetto_property = property_value
end

#tzoffsetto_property_from_string(line) ⇒ Object

:nodoc:



68
69
70
 
# File 'lib/ri_cal/properties/timezone_period.rb', line 68

def tzoffsetto_property_from_string(line) # :nodoc:
  @tzoffsetto_property = RiCal::PropertyValue::UtcOffset.new(self, line)
end