Module: RiCal::Properties::TimezonePeriod

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

Overview

  • ©2009 Rick DeNatale

  • All rights reserved. Refer to the file README.txt for the license

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:


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

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

Instance Method Details

#==(o) ⇒ Object

:nodoc:


371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/ri_cal/properties/timezone_period.rb', line 371

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


146
147
148
# File 'lib/ri_cal/properties/timezone_period.rb', line 146

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


140
141
142
# File 'lib/ri_cal/properties/timezone_period.rb', line 140

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:


396
397
398
399
# File 'lib/ri_cal/properties/timezone_period.rb', line 396

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


209
210
211
# File 'lib/ri_cal/properties/timezone_period.rb', line 209

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


203
204
205
# File 'lib/ri_cal/properties/timezone_period.rb', line 203

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


272
273
274
# File 'lib/ri_cal/properties/timezone_period.rb', line 272

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


266
267
268
# File 'lib/ri_cal/properties/timezone_period.rb', line 266

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


335
336
337
# File 'lib/ri_cal/properties/timezone_period.rb', line 335

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


329
330
331
# File 'lib/ri_cal/properties/timezone_period.rb', line 329

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

#commentObject

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


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

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


134
135
136
# File 'lib/ri_cal/properties/timezone_period.rb', line 134

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

#comment_propertyObject

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


116
117
118
# File 'lib/ri_cal/properties/timezone_period.rb', line 116

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


122
123
124
# File 'lib/ri_cal/properties/timezone_period.rb', line 122

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

#comment_property_from_string(line) ⇒ Object

:nodoc:


168
169
170
# File 'lib/ri_cal/properties/timezone_period.rb', line 168

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


128
129
130
# File 'lib/ri_cal/properties/timezone_period.rb', line 128

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

#dtstartObject

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


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

def dtstart
  dtstart_property ? dtstart_property.ruby_value : nil
end

#dtstart=(ruby_value) ⇒ Object

set the value of the DTSTART property


28
29
30
# File 'lib/ri_cal/properties/timezone_period.rb', line 28

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

#dtstart_propertyObject

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


17
18
19
# File 'lib/ri_cal/properties/timezone_period.rb', line 17

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


23
24
25
# File 'lib/ri_cal/properties/timezone_period.rb', line 23

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

#dtstart_property_from_string(line) ⇒ Object

:nodoc:


38
39
40
# File 'lib/ri_cal/properties/timezone_period.rb', line 38

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

#export_properties_to(export_stream) ⇒ Object

:nodoc:


361
362
363
364
365
366
367
368
369
# File 'lib/ri_cal/properties/timezone_period.rb', line 361

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:


385
386
387
388
389
390
391
392
393
394
# File 'lib/ri_cal/properties/timezone_period.rb', line 385

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_violationObject

:nodoc:


411
412
413
# File 'lib/ri_cal/properties/timezone_period.rb', line 411

def mutual_exclusion_violation #:nodoc:
  false
end

#rdateObject

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


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

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


197
198
199
# File 'lib/ri_cal/properties/timezone_period.rb', line 197

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

#rdate_propertyObject

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


179
180
181
# File 'lib/ri_cal/properties/timezone_period.rb', line 179

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


185
186
187
# File 'lib/ri_cal/properties/timezone_period.rb', line 185

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

#rdate_property_from_string(line) ⇒ Object

:nodoc:


231
232
233
# File 'lib/ri_cal/properties/timezone_period.rb', line 231

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


191
192
193
# File 'lib/ri_cal/properties/timezone_period.rb', line 191

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


158
159
160
# File 'lib/ri_cal/properties/timezone_period.rb', line 158

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


152
153
154
# File 'lib/ri_cal/properties/timezone_period.rb', line 152

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


221
222
223
# File 'lib/ri_cal/properties/timezone_period.rb', line 221

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


215
216
217
# File 'lib/ri_cal/properties/timezone_period.rb', line 215

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


284
285
286
# File 'lib/ri_cal/properties/timezone_period.rb', line 284

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


278
279
280
# File 'lib/ri_cal/properties/timezone_period.rb', line 278

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


347
348
349
# File 'lib/ri_cal/properties/timezone_period.rb', line 347

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


341
342
343
# File 'lib/ri_cal/properties/timezone_period.rb', line 341

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

#rruleObject

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


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

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


260
261
262
# File 'lib/ri_cal/properties/timezone_period.rb', line 260

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

#rrule_propertyObject

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


242
243
244
# File 'lib/ri_cal/properties/timezone_period.rb', line 242

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


248
249
250
# File 'lib/ri_cal/properties/timezone_period.rb', line 248

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

#rrule_property_from_string(line) ⇒ Object

:nodoc:


294
295
296
# File 'lib/ri_cal/properties/timezone_period.rb', line 294

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


254
255
256
# File 'lib/ri_cal/properties/timezone_period.rb', line 254

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

#tznameObject

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


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

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


323
324
325
# File 'lib/ri_cal/properties/timezone_period.rb', line 323

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

#tzname_propertyObject

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


305
306
307
# File 'lib/ri_cal/properties/timezone_period.rb', line 305

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


311
312
313
# File 'lib/ri_cal/properties/timezone_period.rb', line 311

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

#tzname_property_from_string(line) ⇒ Object

:nodoc:


357
358
359
# File 'lib/ri_cal/properties/timezone_period.rb', line 357

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


317
318
319
# File 'lib/ri_cal/properties/timezone_period.rb', line 317

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

#tzoffsetfromObject

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


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

def tzoffsetfrom
  tzoffsetfrom_property ? tzoffsetfrom_property.ruby_value : nil
end

#tzoffsetfrom=(ruby_value) ⇒ Object

set the value of the TZOFFSETFROM property


94
95
96
# File 'lib/ri_cal/properties/timezone_period.rb', line 94

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

#tzoffsetfrom_propertyObject

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


83
84
85
# File 'lib/ri_cal/properties/timezone_period.rb', line 83

def tzoffsetfrom_property
  @tzoffsetfrom_property
end

#tzoffsetfrom_property=(property_value) ⇒ Object

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


89
90
91
# File 'lib/ri_cal/properties/timezone_period.rb', line 89

def tzoffsetfrom_property=(property_value)
  @tzoffsetfrom_property = property_value
end

#tzoffsetfrom_property_from_string(line) ⇒ Object

:nodoc:


104
105
106
# File 'lib/ri_cal/properties/timezone_period.rb', line 104

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

#tzoffsettoObject

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


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

def tzoffsetto
  tzoffsetto_property ? tzoffsetto_property.ruby_value : nil
end

#tzoffsetto=(ruby_value) ⇒ Object

set the value of the TZOFFSETTO property


61
62
63
# File 'lib/ri_cal/properties/timezone_period.rb', line 61

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

#tzoffsetto_propertyObject

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


50
51
52
# File 'lib/ri_cal/properties/timezone_period.rb', line 50

def tzoffsetto_property
  @tzoffsetto_property
end

#tzoffsetto_property=(property_value) ⇒ Object

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


56
57
58
# File 'lib/ri_cal/properties/timezone_period.rb', line 56

def tzoffsetto_property=(property_value)
  @tzoffsetto_property = property_value
end

#tzoffsetto_property_from_string(line) ⇒ Object

:nodoc:


71
72
73
# File 'lib/ri_cal/properties/timezone_period.rb', line 71

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