Module: RiCal::Properties::Timezone

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

Overview

Properties::Timezone provides property accessing methods for the Timezone 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:



138
139
140
 
# File 'lib/ri_cal/properties/timezone.rb', line 138

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

Instance Method Details

#==(o) ⇒ Object

:nodoc:



112
113
114
115
116
117
118
119
120
 
# File 'lib/ri_cal/properties/timezone.rb', line 112

def ==(o) #:nodoc:
  if o.class == self.class
  (tzurl_property == o.tzurl_property) &&
  (last_modified_property == o.last_modified_property) &&
  (tzid_property == o.tzid_property)
  else
     super
  end
end

#add_date_times_to(required_timezones) ⇒ Object

:nodoc:



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

def add_date_times_to(required_timezones) #:nodoc:
end

#export_properties_to(export_stream) ⇒ Object

:nodoc:



106
107
108
109
110
 
# File 'lib/ri_cal/properties/timezone.rb', line 106

def export_properties_to(export_stream) #:nodoc:
  export_prop_to(export_stream, "TZURL", @tzurl_property)
  export_prop_to(export_stream, "LAST-MODIFIED", @last_modified_property)
  export_prop_to(export_stream, "TZID", @tzid_property)
end

#initialize_copy(o) ⇒ Object

:nodoc:



122
123
124
125
126
127
 
# File 'lib/ri_cal/properties/timezone.rb', line 122

def initialize_copy(o) #:nodoc:
  super
  tzurl_property = tzurl_property && tzurl_property.dup
  last_modified_property = last_modified_property && last_modified_property.dup
  tzid_property = tzid_property && tzid_property.dup
end

#last_modified ⇒ Object

return the value of the LAST-MODIFIED property which will be an instance of ZuluDateTime



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

def last_modified
  last_modified_property ? last_modified_property.ruby_value : nil
end

#last_modified=(ruby_value) ⇒ Object

set the value of the LAST-MODIFIED property



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

def last_modified=(ruby_value)
  self.last_modified_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value)
end

#last_modified_property ⇒ Object

return the the LAST-MODIFIED property which will be an instances of RiCal::PropertyValueZuluDateTime

purpose (from RFC 2445)

This property specifies the date and time that the information associated with the calendar component was last revised in teh calendar store.

see RFC 2445 4.8.7.3 p 131



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

def last_modified_property
  @last_modified_property
end

#last_modified_property=(property_value) ⇒ Object

set the LAST-MODIFIED property property value should be an instance of RiCal::PropertyValueZuluDateTime



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

def last_modified_property=(property_value)
  @last_modified_property = property_value
end

#last_modified_property_from_string(line) ⇒ Object

:nodoc:



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

def last_modified_property_from_string(line) # :nodoc:
  @last_modified_property = RiCal::PropertyValue::ZuluDateTime.new(self, line)
end

#mutual_exclusion_violation ⇒ Object

:nodoc:



142
143
144
 
# File 'lib/ri_cal/properties/timezone.rb', line 142

def mutual_exclusion_violation #:nodoc:
  false
end

#tzid ⇒ Object

return the value of the TZID property which will be an instance of String



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

def tzid
  tzid_property ? tzid_property.ruby_value : nil
end

#tzid=(ruby_value) ⇒ Object

set the value of the TZID property



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

def tzid=(ruby_value)
  self.tzid_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#tzid_property ⇒ Object

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

purpose (from RFC 2445)

This property specifies the text value that uniquely indentifies the “VTIMEZONE” calendar component.

see RFC 2445 4.8.3.1 pp 97-98



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

def tzid_property
  @tzid_property
end

#tzid_property=(property_value) ⇒ Object

set the TZID property property value should be an instance of RiCal::PropertyValueText



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

def tzid_property=(property_value)
  @tzid_property = property_value
end

#tzid_property_from_string(line) ⇒ Object

:nodoc:



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

def tzid_property_from_string(line) # :nodoc:
  @tzid_property = RiCal::PropertyValue::Text.new(self, line)
end

#tzurl ⇒ Object

return the value of the TZURL property which will be an instance of Uri



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

def tzurl
  tzurl_property ? tzurl_property.ruby_value : nil
end

#tzurl=(ruby_value) ⇒ Object

set the value of the TZURL property



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

def tzurl=(ruby_value)
  self.tzurl_property= RiCal::PropertyValue::Uri.convert(self, ruby_value)
end

#tzurl_property ⇒ Object

return the the TZURL property which will be an instances of RiCal::PropertyValueUri

purpose (from RFC 2445)

The TZURL provies a means for a VTIMEZONE component to point to a network location that can be used to retrieve an up-to_date version of itself.

see RFC 2445 4.8.3.4 p 101



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

def tzurl_property
  @tzurl_property
end

#tzurl_property=(property_value) ⇒ Object

set the TZURL property property value should be an instance of RiCal::PropertyValueUri



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

def tzurl_property=(property_value)
  @tzurl_property = property_value
end

#tzurl_property_from_string(line) ⇒ Object

:nodoc:



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

def tzurl_property_from_string(line) # :nodoc:
  @tzurl_property = RiCal::PropertyValue::Uri.new(self, line)
end