Module: RiCal::Properties::Journal

Included in:
Component::Journal
Defined in:
lib/ri_cal/properties/journal.rb

Overview

  • ©2009 Rick DeNatale

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

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


1228
1229
1230
# File 'lib/ri_cal/properties/journal.rb', line 1228

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

Instance Method Details

#==(o) ⇒ Object

:nodoc:


1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'lib/ri_cal/properties/journal.rb', line 1156

def ==(o) #:nodoc:
  if o.class == self.class
  (rdate_property == o.rdate_property) &&
  (contact_property == o.contact_property) &&
  (exdate_property == o.exdate_property) &&
  (created_property == o.created_property) &&
  (status_property == o.status_property) &&
  (dtstart_property == o.dtstart_property) &&
  (recurrence_id_property == o.recurrence_id_property) &&
  (dtstamp_property == o.dtstamp_property) &&
  (categories_property == o.categories_property) &&
  (last_modified_property == o.last_modified_property) &&
  (attendee_property == o.attendee_property) &&
  (uid_property == o.uid_property) &&
  (description_property == o.description_property) &&
  (url_property == o.url_property) &&
  (summary_property == o.summary_property) &&
  (organizer_property == o.organizer_property) &&
  (rrule_property == o.rrule_property) &&
  (attach_property == o.attach_property) &&
  (class_property == o.class_property) &&
  (request_status_property == o.request_status_property) &&
  (related_to_property == o.related_to_property) &&
  (exrule_property == o.exrule_property) &&
  (comment_property == o.comment_property) &&
  (sequence_property == o.sequence_property)
  else
     super
  end
end

#add_attach(ruby_value) ⇒ Object

add one value to the ATTACH property one instances of Uri may be passed to this method


476
477
478
# File 'lib/ri_cal/properties/journal.rb', line 476

def  add_attach(ruby_value)
 self.attach_property << RiCal::PropertyValue::Uri.convert(self, ruby_value)
end

#add_attachments(*ruby_values) ⇒ Object

add one or more values to the ATTACH property one or more instances of Uri may be passed to this method


470
471
472
# File 'lib/ri_cal/properties/journal.rb', line 470

def  add_attachments(*ruby_values)
 ruby_values.each {|val|  self.attach_property << RiCal::PropertyValue::Uri.convert(self, val)}
end

#add_attendee(ruby_value) ⇒ Object

add one value to the ATTENDEE property one instances of CalAddress may be passed to this method


539
540
541
# File 'lib/ri_cal/properties/journal.rb', line 539

def  add_attendee(ruby_value)
 self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
end

#add_attendees(*ruby_values) ⇒ Object

add one or more values to the ATTENDEE property one or more instances of CalAddress may be passed to this method


533
534
535
# File 'lib/ri_cal/properties/journal.rb', line 533

def  add_attendees(*ruby_values)
 ruby_values.each {|val|  self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)}
end

#add_categories(ruby_value) ⇒ Object

add one value to the CATEGORIES property one instances of Array may be passed to this method


602
603
604
# File 'lib/ri_cal/properties/journal.rb', line 602

def  add_categories(ruby_value)
 self.categories_property << RiCal::PropertyValue::Array.convert(self, ruby_value)
end

#add_comment(ruby_value) ⇒ Object

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


665
666
667
# File 'lib/ri_cal/properties/journal.rb', line 665

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


659
660
661
# File 'lib/ri_cal/properties/journal.rb', line 659

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

#add_contact(ruby_value) ⇒ Object

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


728
729
730
# File 'lib/ri_cal/properties/journal.rb', line 728

def  add_contact(ruby_value)
 self.contact_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#add_contacts(*ruby_values) ⇒ Object

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


722
723
724
# File 'lib/ri_cal/properties/journal.rb', line 722

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

#add_date_times_to(required_timezones) ⇒ Object

:nodoc:


1215
1216
1217
1218
1219
1220
# File 'lib/ri_cal/properties/journal.rb', line 1215

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

#add_exdate(*ruby_value) ⇒ Object

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


791
792
793
# File 'lib/ri_cal/properties/journal.rb', line 791

def  add_exdate(*ruby_value)
 self.exdate_property << RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value)
end

#add_exdates(*ruby_values) ⇒ Object

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


785
786
787
# File 'lib/ri_cal/properties/journal.rb', line 785

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

#add_exrule(ruby_value) ⇒ Object

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


854
855
856
# File 'lib/ri_cal/properties/journal.rb', line 854

def  add_exrule(ruby_value)
 self.exrule_property << RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value)
end

#add_exrules(*ruby_values) ⇒ Object

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


848
849
850
# File 'lib/ri_cal/properties/journal.rb', line 848

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

#add_multiple_categories(*ruby_values) ⇒ Object

add one or more values to the CATEGORIES property one or more instances of Array may be passed to this method


596
597
598
# File 'lib/ri_cal/properties/journal.rb', line 596

def  add_multiple_categories(*ruby_values)
 ruby_values.each {|val|  self.categories_property << RiCal::PropertyValue::Array.convert(self, val)}
end

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


911
912
913
# File 'lib/ri_cal/properties/journal.rb', line 911

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

#add_rdate(*ruby_value) ⇒ Object

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


980
981
982
# File 'lib/ri_cal/properties/journal.rb', line 980

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


974
975
976
# File 'lib/ri_cal/properties/journal.rb', line 974

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

add one value to the RELATED-TO property one instances of String may be passed to this method


917
918
919
# File 'lib/ri_cal/properties/journal.rb', line 917

def  add_related_to(ruby_value)
 self.related_to_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#add_request_status(ruby_value) ⇒ Object

add one value to the REQUEST-STATUS property one instances of String may be passed to this method


1103
1104
1105
# File 'lib/ri_cal/properties/journal.rb', line 1103

def  add_request_status(ruby_value)
 self.request_status_property << RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#add_request_statuses(*ruby_values) ⇒ Object

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


1097
1098
1099
# File 'lib/ri_cal/properties/journal.rb', line 1097

def  add_request_statuses(*ruby_values)
 ruby_values.each {|val|  self.request_status_property << RiCal::PropertyValue::Text.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


1043
1044
1045
# File 'lib/ri_cal/properties/journal.rb', line 1043

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


1037
1038
1039
# File 'lib/ri_cal/properties/journal.rb', line 1037

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

#attachObject

return the value of the ATTACH property which will be an array of instances of Uri


494
495
496
# File 'lib/ri_cal/properties/journal.rb', line 494

def attach
  attach_property.map {|prop| prop ? prop.ruby_value : prop}
end

#attach=(ruby_value) ⇒ Object

set the value of the ATTACH property to a single value one instance of Uri may be passed to this method


464
465
466
# File 'lib/ri_cal/properties/journal.rb', line 464

def attach=(ruby_value)
  @attach_property = [RiCal::PropertyValue::Uri.convert(self, ruby_value)]
end

#attach_propertyObject

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

purpose (from RFC 2445)

The property provides the capability to associate a document object with a calendar component.

see RFC 2445 4.8.1.1 pp 77-78


446
447
448
# File 'lib/ri_cal/properties/journal.rb', line 446

def attach_property
  @attach_property ||= []
end

#attach_property=(*property_values) ⇒ Object

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


452
453
454
# File 'lib/ri_cal/properties/journal.rb', line 452

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

#attach_property_from_string(line) ⇒ Object

:nodoc:


498
499
500
# File 'lib/ri_cal/properties/journal.rb', line 498

def attach_property_from_string(line) # :nodoc:
  attach_property << RiCal::PropertyValue::Uri.new(self, line)
end

#attachments=(ruby_values) ⇒ Object

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


458
459
460
# File 'lib/ri_cal/properties/journal.rb', line 458

def attachments=(ruby_values)
  @attach_property = ruby_values.map {|val| RiCal::PropertyValue::Uri.convert(self, val)}
end

#attendeeObject

return the value of the ATTENDEE property which will be an array of instances of CalAddress


557
558
559
# File 'lib/ri_cal/properties/journal.rb', line 557

def attendee
  attendee_property.map {|prop| prop ? prop.ruby_value : prop}
end

#attendee=(ruby_value) ⇒ Object

set the value of the ATTENDEE property to a single value one instance of CalAddress may be passed to this method


527
528
529
# File 'lib/ri_cal/properties/journal.rb', line 527

def attendee=(ruby_value)
  @attendee_property = [RiCal::PropertyValue::CalAddress.convert(self, ruby_value)]
end

#attendee_propertyObject

return the the ATTENDEE property which will be an array of instances of RiCal::PropertyValueCalAddress

purpose (from RFC 2445)

The property defines an 'Attendee' within a calendar component.

see RFC 2445 4.8.4.1 pp 102-104


509
510
511
# File 'lib/ri_cal/properties/journal.rb', line 509

def attendee_property
  @attendee_property ||= []
end

#attendee_property=(*property_values) ⇒ Object

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


515
516
517
# File 'lib/ri_cal/properties/journal.rb', line 515

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

#attendee_property_from_string(line) ⇒ Object

:nodoc:


561
562
563
# File 'lib/ri_cal/properties/journal.rb', line 561

def attendee_property_from_string(line) # :nodoc:
  attendee_property << RiCal::PropertyValue::CalAddress.new(self, line)
end

#attendees=(ruby_values) ⇒ Object

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


521
522
523
# File 'lib/ri_cal/properties/journal.rb', line 521

def attendees=(ruby_values)
  @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.convert(self, val)}
end

#categoriesObject

return the value of the CATEGORIES property which will be an array of instances of Array


620
621
622
# File 'lib/ri_cal/properties/journal.rb', line 620

def categories
  categories_property.map {|prop| prop ? prop.ruby_value : prop}
end

#categories=(ruby_value) ⇒ Object

set the value of the CATEGORIES property to a single value one instance of Array may be passed to this method


590
591
592
# File 'lib/ri_cal/properties/journal.rb', line 590

def categories=(ruby_value)
  @categories_property = [RiCal::PropertyValue::Array.convert(self, ruby_value)]
end

#categories_propertyObject

return the the CATEGORIES property which will be an array of instances of RiCal::PropertyValueArray

purpose (from RFC 2445)

This property defines the categories for a calendar component.

see RFC 2445 4.8.1.2 pp 78-79


572
573
574
# File 'lib/ri_cal/properties/journal.rb', line 572

def categories_property
  @categories_property ||= []
end

#categories_property=(*property_values) ⇒ Object

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


578
579
580
# File 'lib/ri_cal/properties/journal.rb', line 578

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

#categories_property_from_string(line) ⇒ Object

:nodoc:


624
625
626
# File 'lib/ri_cal/properties/journal.rb', line 624

def categories_property_from_string(line) # :nodoc:
  categories_property << RiCal::PropertyValue::Array.new(self, line)
end

#class_propertyObject

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

purpose (from RFC 2445)

This property defines the access classification for a calendar component.

see RFC 2445 4.8.1.3 pp 79-80


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

def class_property
  @class_property
end

#class_property=(property_value) ⇒ Object

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


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

def class_property=(property_value)
  @class_property = property_value
end

#class_property_from_string(line) ⇒ Object

:nodoc:


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

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

#commentObject

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


683
684
685
# File 'lib/ri_cal/properties/journal.rb', line 683

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


653
654
655
# File 'lib/ri_cal/properties/journal.rb', line 653

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


635
636
637
# File 'lib/ri_cal/properties/journal.rb', line 635

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


641
642
643
# File 'lib/ri_cal/properties/journal.rb', line 641

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

#comment_property_from_string(line) ⇒ Object

:nodoc:


687
688
689
# File 'lib/ri_cal/properties/journal.rb', line 687

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


647
648
649
# File 'lib/ri_cal/properties/journal.rb', line 647

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

#contactObject

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


746
747
748
# File 'lib/ri_cal/properties/journal.rb', line 746

def contact
  contact_property.map {|prop| prop ? prop.ruby_value : prop}
end

#contact=(ruby_value) ⇒ Object

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


716
717
718
# File 'lib/ri_cal/properties/journal.rb', line 716

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

#contact_propertyObject

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

purpose (from RFC 2445)

The property is used to represent contact information oralternately a reference to contact information associated with the calendar component.

see RFC 2445 4.8.4.2 pp 104-106


698
699
700
# File 'lib/ri_cal/properties/journal.rb', line 698

def contact_property
  @contact_property ||= []
end

#contact_property=(*property_values) ⇒ Object

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


704
705
706
# File 'lib/ri_cal/properties/journal.rb', line 704

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

#contact_property_from_string(line) ⇒ Object

:nodoc:


750
751
752
# File 'lib/ri_cal/properties/journal.rb', line 750

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

#contacts=(ruby_values) ⇒ Object

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


710
711
712
# File 'lib/ri_cal/properties/journal.rb', line 710

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

#createdObject

return the value of the CREATED property which will be an instance of ZuluDateTime


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

def created
  created_property ? created_property.ruby_value : nil
end

#created=(ruby_value) ⇒ Object

set the value of the CREATED property


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

def created=(ruby_value)
  self.created_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value)
end

#created_propertyObject

return the the CREATED property which will be an instances of RiCal::PropertyValueZuluDateTime

purpose (from RFC 2445)

This property specifies the date and time that the calendar information was created by teh calendar user agent in the calendar store.

see RFC 2445 4.8.7.1 pp 129-130


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

def created_property
  @created_property
end

#created_property=(property_value) ⇒ Object

set the CREATED property property value should be an instance of RiCal::PropertyValueZuluDateTime


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

def created_property=(property_value)
  @created_property = property_value
end

#created_property_from_string(line) ⇒ Object

:nodoc:


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

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

#descriptionObject

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


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

def description
  description_property ? description_property.ruby_value : nil
end

#description=(ruby_value) ⇒ Object

set the value of the DESCRIPTION property


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

def description=(ruby_value)
  self.description_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#description_propertyObject

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

purpose (from RFC 2445)

This property provides a more complete description of the calendar component, than that provided by the “SUMMARY” property.

see RFC 2445 4.8.1.5 pp 81-82


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

def description_property
  @description_property
end

#description_property=(property_value) ⇒ Object

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


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

def description_property=(property_value)
  @description_property = property_value
end

#description_property_from_string(line) ⇒ Object

:nodoc:


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

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

#dtstampObject

return the value of the DTSTAMP property which will be an instance of ZuluDateTime


166
167
168
# File 'lib/ri_cal/properties/journal.rb', line 166

def dtstamp
  dtstamp_property ? dtstamp_property.ruby_value : nil
end

#dtstamp=(ruby_value) ⇒ Object

set the value of the DTSTAMP property


160
161
162
# File 'lib/ri_cal/properties/journal.rb', line 160

def dtstamp=(ruby_value)
  self.dtstamp_property= RiCal::PropertyValue::ZuluDateTime.convert(self, ruby_value)
end

#dtstamp_propertyObject

return the the DTSTAMP property which will be an instances of RiCal::PropertyValueZuluDateTime

purpose (from RFC 2445)

This property indicates the date/time that the instance of the iCalendar object was created.

see RFC 2445 4.8.7.2 pp 130-131


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

def dtstamp_property
  @dtstamp_property
end

#dtstamp_property=(property_value) ⇒ Object

set the DTSTAMP property property value should be an instance of RiCal::PropertyValueZuluDateTime


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

def dtstamp_property=(property_value)
  @dtstamp_property = property_value
end

#dtstamp_property_from_string(line) ⇒ Object

:nodoc:


170
171
172
# File 'lib/ri_cal/properties/journal.rb', line 170

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

#dtstartObject

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


133
134
135
# File 'lib/ri_cal/properties/journal.rb', line 133

def dtstart
  dtstart_property ? dtstart_property.ruby_value : nil
end

#dtstart=(ruby_value) ⇒ Object

set the value of the DTSTART property


127
128
129
# File 'lib/ri_cal/properties/journal.rb', line 127

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


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

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


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

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

#dtstart_property_from_string(line) ⇒ Object

:nodoc:


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

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

#exdateObject

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


809
810
811
# File 'lib/ri_cal/properties/journal.rb', line 809

def exdate
  exdate_property.map {|prop| prop ? prop.ruby_value : prop}
end

#exdate=(*ruby_value) ⇒ Object

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


779
780
781
# File 'lib/ri_cal/properties/journal.rb', line 779

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

#exdate_propertyObject

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

purpose (from RFC 2445)

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

see RFC 2445 4.8.5.1 pp 112-114


761
762
763
# File 'lib/ri_cal/properties/journal.rb', line 761

def exdate_property
  @exdate_property ||= []
end

#exdate_property=(*property_values) ⇒ Object

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


767
768
769
# File 'lib/ri_cal/properties/journal.rb', line 767

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

#exdate_property_from_string(line) ⇒ Object

:nodoc:


813
814
815
# File 'lib/ri_cal/properties/journal.rb', line 813

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

#exdates=(ruby_values) ⇒ Object

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


773
774
775
# File 'lib/ri_cal/properties/journal.rb', line 773

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

#export_properties_to(export_stream) ⇒ Object

:nodoc:


1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
# File 'lib/ri_cal/properties/journal.rb', line 1129

def export_properties_to(export_stream) #:nodoc:
  export_prop_to(export_stream, "RDATE", @rdate_property)
  export_prop_to(export_stream, "CONTACT", @contact_property)
  export_prop_to(export_stream, "EXDATE", @exdate_property)
  export_prop_to(export_stream, "CREATED", @created_property)
  export_prop_to(export_stream, "STATUS", @status_property)
  export_prop_to(export_stream, "DTSTART", @dtstart_property)
  export_prop_to(export_stream, "RECURRENCE-ID", @recurrence_id_property)
  export_prop_to(export_stream, "DTSTAMP", @dtstamp_property)
  export_prop_to(export_stream, "CATEGORIES", @categories_property)
  export_prop_to(export_stream, "LAST-MODIFIED", @last_modified_property)
  export_prop_to(export_stream, "ATTENDEE", @attendee_property)
  export_prop_to(export_stream, "UID", @uid_property)
  export_prop_to(export_stream, "DESCRIPTION", @description_property)
  export_prop_to(export_stream, "URL", @url_property)
  export_prop_to(export_stream, "SUMMARY", @summary_property)
  export_prop_to(export_stream, "ORGANIZER", @organizer_property)
  export_prop_to(export_stream, "RRULE", @rrule_property)
  export_prop_to(export_stream, "ATTACH", @attach_property)
  export_prop_to(export_stream, "CLASS", @class_property)
  export_prop_to(export_stream, "REQUEST-STATUS", @request_status_property)
  export_prop_to(export_stream, "RELATED-TO", @related_to_property)
  export_prop_to(export_stream, "EXRULE", @exrule_property)
  export_prop_to(export_stream, "COMMENT", @comment_property)
  export_prop_to(export_stream, "SEQUENCE", @sequence_property)
end

#exruleObject

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


872
873
874
# File 'lib/ri_cal/properties/journal.rb', line 872

def exrule
  exrule_property.map {|prop| prop ? prop.ruby_value : prop}
end

#exrule=(ruby_value) ⇒ Object

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


842
843
844
# File 'lib/ri_cal/properties/journal.rb', line 842

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

#exrule_propertyObject

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

purpose (from RFC 2445)

This property defines a rule or repeating pattern for an exception to a recurrence set.

see RFC 2445 4.8.5.2 pp 114-125


824
825
826
# File 'lib/ri_cal/properties/journal.rb', line 824

def exrule_property
  @exrule_property ||= []
end

#exrule_property=(*property_values) ⇒ Object

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


830
831
832
# File 'lib/ri_cal/properties/journal.rb', line 830

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

#exrule_property_from_string(line) ⇒ Object

:nodoc:


876
877
878
# File 'lib/ri_cal/properties/journal.rb', line 876

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

#exrules=(ruby_values) ⇒ Object

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


836
837
838
# File 'lib/ri_cal/properties/journal.rb', line 836

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

#initialize_copy(o) ⇒ Object

:nodoc:


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
# File 'lib/ri_cal/properties/journal.rb', line 1187

def initialize_copy(o) #:nodoc:
  super
  rdate_property = rdate_property && rdate_property.dup
  contact_property = contact_property && contact_property.dup
  exdate_property = exdate_property && exdate_property.dup
  created_property = created_property && created_property.dup
  status_property = status_property && status_property.dup
  dtstart_property = dtstart_property && dtstart_property.dup
  recurrence_id_property = recurrence_id_property && recurrence_id_property.dup
  dtstamp_property = dtstamp_property && dtstamp_property.dup
  categories_property = categories_property && categories_property.dup
  last_modified_property = last_modified_property && last_modified_property.dup
  attendee_property = attendee_property && attendee_property.dup
  uid_property = uid_property && uid_property.dup
  description_property = description_property && description_property.dup
  url_property = url_property && url_property.dup
  summary_property = summary_property && summary_property.dup
  organizer_property = organizer_property && organizer_property.dup
  rrule_property = rrule_property && rrule_property.dup
  attach_property = attach_property && attach_property.dup
  class_property = class_property && class_property.dup
  request_status_property = request_status_property && request_status_property.dup
  related_to_property = related_to_property && related_to_property.dup
  exrule_property = exrule_property && exrule_property.dup
  comment_property = comment_property && comment_property.dup
  sequence_property = sequence_property && sequence_property.dup
end

#last_modifiedObject

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


199
200
201
# File 'lib/ri_cal/properties/journal.rb', line 199

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


193
194
195
# File 'lib/ri_cal/properties/journal.rb', line 193

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

#last_modified_propertyObject

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


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

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


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

def last_modified_property=(property_value)
  @last_modified_property = property_value
end

#last_modified_property_from_string(line) ⇒ Object

:nodoc:


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

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

#multiple_categories=(ruby_values) ⇒ Object

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


584
585
586
# File 'lib/ri_cal/properties/journal.rb', line 584

def multiple_categories=(ruby_values)
  @categories_property = ruby_values.map {|val| RiCal::PropertyValue::Array.convert(self, val)}
end

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


899
900
901
# File 'lib/ri_cal/properties/journal.rb', line 899

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

#mutual_exclusion_violationObject

:nodoc:


1232
1233
1234
# File 'lib/ri_cal/properties/journal.rb', line 1232

def mutual_exclusion_violation #:nodoc:
  false
end

#organizerObject

return the value of the ORGANIZER property which will be an instance of CalAddress


232
233
234
# File 'lib/ri_cal/properties/journal.rb', line 232

def organizer
  organizer_property ? organizer_property.ruby_value : nil
end

#organizer=(ruby_value) ⇒ Object

set the value of the ORGANIZER property


226
227
228
# File 'lib/ri_cal/properties/journal.rb', line 226

def organizer=(ruby_value)
  self.organizer_property= RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
end

#organizer_propertyObject

return the the ORGANIZER property which will be an instances of RiCal::PropertyValueCalAddress

purpose (from RFC 2445)

The property defines the organizer for a calendar component.

see RFC 2445 4.8.4.3 pp 106-107


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

def organizer_property
  @organizer_property
end

#organizer_property=(property_value) ⇒ Object

set the ORGANIZER property property value should be an instance of RiCal::PropertyValueCalAddress


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

def organizer_property=(property_value)
  @organizer_property = property_value
end

#organizer_property_from_string(line) ⇒ Object

:nodoc:


236
237
238
# File 'lib/ri_cal/properties/journal.rb', line 236

def organizer_property_from_string(line) # :nodoc:
  @organizer_property = RiCal::PropertyValue::CalAddress.new(self, line)
end

#rdateObject

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


998
999
1000
# File 'lib/ri_cal/properties/journal.rb', line 998

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


968
969
970
# File 'lib/ri_cal/properties/journal.rb', line 968

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


950
951
952
# File 'lib/ri_cal/properties/journal.rb', line 950

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


956
957
958
# File 'lib/ri_cal/properties/journal.rb', line 956

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

#rdate_property_from_string(line) ⇒ Object

:nodoc:


1002
1003
1004
# File 'lib/ri_cal/properties/journal.rb', line 1002

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


962
963
964
# File 'lib/ri_cal/properties/journal.rb', line 962

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

#recurrence_idObject

return the value of the RECURRENCE-ID property which will be an instance of either DateTime or Date


265
266
267
# File 'lib/ri_cal/properties/journal.rb', line 265

def recurrence_id
  recurrence_id_property ? recurrence_id_property.ruby_value : nil
end

#recurrence_id=(ruby_value) ⇒ Object

set the value of the RECURRENCE-ID property


259
260
261
# File 'lib/ri_cal/properties/journal.rb', line 259

def recurrence_id=(ruby_value)
  self.recurrence_id_property= RiCal::PropertyValue::DateTime.convert(self, ruby_value)
end

#recurrence_id_propertyObject

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

purpose (from RFC 2445)

This property is used in conjunction with the “UID” and “SEQUENCE” property to identify a specific instance of a recurring “VEVENT”, “VTODO” or “VJOURNAL” calendar component. The property value is the effective value of the “DTSTART” property of the recurrence instance.

see RFC 2445 4.8.4.4 pp 107-109


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

def recurrence_id_property
  @recurrence_id_property
end

#recurrence_id_property=(property_value) ⇒ Object

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


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

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

#recurrence_id_property_from_string(line) ⇒ Object

:nodoc:


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

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

return the value of the RELATED-TO property which will be an array of instances of String


935
936
937
# File 'lib/ri_cal/properties/journal.rb', line 935

def related_to
  related_to_property.map {|prop| prop ? prop.ruby_value : prop}
end

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


905
906
907
# File 'lib/ri_cal/properties/journal.rb', line 905

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

return the the RELATED-TO property which will be an array of instances of RiCal::PropertyValueText

purpose (from RFC 2445)

The property is used to represent a relationship or reference between one calendar component and another.

see RFC 2445 4.8.4.5 pp 109-110


887
888
889
# File 'lib/ri_cal/properties/journal.rb', line 887

def related_to_property
  @related_to_property ||= []
end

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


893
894
895
# File 'lib/ri_cal/properties/journal.rb', line 893

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

:nodoc:


939
940
941
# File 'lib/ri_cal/properties/journal.rb', line 939

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

#remove_attach(ruby_value) ⇒ Object

remove one value from the ATTACH property one instances of Uri may be passed to this method


488
489
490
# File 'lib/ri_cal/properties/journal.rb', line 488

def  remove_attach(ruby_value)
 self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, ruby_value))
end

#remove_attachments(*ruby_values) ⇒ Object

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


482
483
484
# File 'lib/ri_cal/properties/journal.rb', line 482

def  remove_attachments(*ruby_values)
 ruby_values.each {|val|  self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, val))}
end

#remove_attendee(ruby_value) ⇒ Object

remove one value from the ATTENDEE property one instances of CalAddress may be passed to this method


551
552
553
# File 'lib/ri_cal/properties/journal.rb', line 551

def  remove_attendee(ruby_value)
 self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, ruby_value))
end

#remove_attendees(*ruby_values) ⇒ Object

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


545
546
547
# File 'lib/ri_cal/properties/journal.rb', line 545

def  remove_attendees(*ruby_values)
 ruby_values.each {|val|  self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, val))}
end

#remove_categories(ruby_value) ⇒ Object

remove one value from the CATEGORIES property one instances of Array may be passed to this method


614
615
616
# File 'lib/ri_cal/properties/journal.rb', line 614

def  remove_categories(ruby_value)
 self.categories_property.delete(RiCal::PropertyValue::Array.convert(self, ruby_value))
end

#remove_comment(ruby_value) ⇒ Object

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


677
678
679
# File 'lib/ri_cal/properties/journal.rb', line 677

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


671
672
673
# File 'lib/ri_cal/properties/journal.rb', line 671

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

#remove_contact(ruby_value) ⇒ Object

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


740
741
742
# File 'lib/ri_cal/properties/journal.rb', line 740

def  remove_contact(ruby_value)
 self.contact_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
end

#remove_contacts(*ruby_values) ⇒ Object

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


734
735
736
# File 'lib/ri_cal/properties/journal.rb', line 734

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

#remove_exdate(*ruby_value) ⇒ Object

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


803
804
805
# File 'lib/ri_cal/properties/journal.rb', line 803

def  remove_exdate(*ruby_value)
 self.exdate_property.delete(RiCal::PropertyValue::OccurrenceList.convert(self, *ruby_value))
end

#remove_exdates(*ruby_values) ⇒ Object

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


797
798
799
# File 'lib/ri_cal/properties/journal.rb', line 797

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

#remove_exrule(ruby_value) ⇒ Object

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


866
867
868
# File 'lib/ri_cal/properties/journal.rb', line 866

def  remove_exrule(ruby_value)
 self.exrule_property.delete(RiCal::PropertyValue::RecurrenceRule.convert(self, ruby_value))
end

#remove_exrules(*ruby_values) ⇒ Object

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


860
861
862
# File 'lib/ri_cal/properties/journal.rb', line 860

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

#remove_multiple_categories(*ruby_values) ⇒ Object

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


608
609
610
# File 'lib/ri_cal/properties/journal.rb', line 608

def  remove_multiple_categories(*ruby_values)
 ruby_values.each {|val|  self.categories_property.delete(RiCal::PropertyValue::Array.convert(self, val))}
end

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


923
924
925
# File 'lib/ri_cal/properties/journal.rb', line 923

def  remove_multiple_related_to(*ruby_values)
 ruby_values.each {|val|  self.related_to_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


992
993
994
# File 'lib/ri_cal/properties/journal.rb', line 992

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


986
987
988
# File 'lib/ri_cal/properties/journal.rb', line 986

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

remove one value from the RELATED-TO property one instances of String may be passed to this method


929
930
931
# File 'lib/ri_cal/properties/journal.rb', line 929

def  remove_related_to(ruby_value)
 self.related_to_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
end

#remove_request_status(ruby_value) ⇒ Object

remove one value from the REQUEST-STATUS property one instances of String may be passed to this method


1115
1116
1117
# File 'lib/ri_cal/properties/journal.rb', line 1115

def  remove_request_status(ruby_value)
 self.request_status_property.delete(RiCal::PropertyValue::Text.convert(self, ruby_value))
end

#remove_request_statuses(*ruby_values) ⇒ Object

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


1109
1110
1111
# File 'lib/ri_cal/properties/journal.rb', line 1109

def  remove_request_statuses(*ruby_values)
 ruby_values.each {|val|  self.request_status_property.delete(RiCal::PropertyValue::Text.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


1055
1056
1057
# File 'lib/ri_cal/properties/journal.rb', line 1055

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


1049
1050
1051
# File 'lib/ri_cal/properties/journal.rb', line 1049

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

#request_statusObject

return the value of the REQUEST-STATUS property which will be an array of instances of String


1121
1122
1123
# File 'lib/ri_cal/properties/journal.rb', line 1121

def request_status
  request_status_property.map {|prop| prop ? prop.ruby_value : prop}
end

#request_status=(ruby_value) ⇒ Object

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


1091
1092
1093
# File 'lib/ri_cal/properties/journal.rb', line 1091

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

#request_status_propertyObject

return the the REQUEST-STATUS property which will be an array of instances of RiCal::PropertyValueText

see RFC 2445 4.8.8.2 pp 134-136


1073
1074
1075
# File 'lib/ri_cal/properties/journal.rb', line 1073

def request_status_property
  @request_status_property ||= []
end

#request_status_property=(*property_values) ⇒ Object

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


1079
1080
1081
# File 'lib/ri_cal/properties/journal.rb', line 1079

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

#request_status_property_from_string(line) ⇒ Object

:nodoc:


1125
1126
1127
# File 'lib/ri_cal/properties/journal.rb', line 1125

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

#request_statuses=(ruby_values) ⇒ Object

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


1085
1086
1087
# File 'lib/ri_cal/properties/journal.rb', line 1085

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

#rruleObject

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


1061
1062
1063
# File 'lib/ri_cal/properties/journal.rb', line 1061

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


1031
1032
1033
# File 'lib/ri_cal/properties/journal.rb', line 1031

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


1013
1014
1015
# File 'lib/ri_cal/properties/journal.rb', line 1013

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


1019
1020
1021
# File 'lib/ri_cal/properties/journal.rb', line 1019

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

#rrule_property_from_string(line) ⇒ Object

:nodoc:


1065
1066
1067
# File 'lib/ri_cal/properties/journal.rb', line 1065

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


1025
1026
1027
# File 'lib/ri_cal/properties/journal.rb', line 1025

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

#security_classObject

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


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

def security_class
  class_property ? class_property.ruby_value : nil
end

#security_class=(ruby_value) ⇒ Object

set the value of the CLASS property


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

def security_class=(ruby_value)
  self.class_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#sequenceObject

return the value of the SEQUENCE property which will be an instance of Integer


298
299
300
# File 'lib/ri_cal/properties/journal.rb', line 298

def sequence
  sequence_property ? sequence_property.ruby_value : nil
end

#sequence=(ruby_value) ⇒ Object

set the value of the SEQUENCE property


292
293
294
# File 'lib/ri_cal/properties/journal.rb', line 292

def sequence=(ruby_value)
  self.sequence_property= RiCal::PropertyValue::Integer.convert(self, ruby_value)
end

#sequence_propertyObject

return the the SEQUENCE property which will be an instances of RiCal::PropertyValueInteger

purpose (from RFC 2445)

This property defines the revision sequence number of the calendar component within a sequence of revisions.

see RFC 2445 4.8.7.4 pp 131-133


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

def sequence_property
  @sequence_property
end

#sequence_property=(property_value) ⇒ Object

set the SEQUENCE property property value should be an instance of RiCal::PropertyValueInteger


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

def sequence_property=(property_value)
  @sequence_property = property_value
end

#sequence_property_from_string(line) ⇒ Object

:nodoc:


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

def sequence_property_from_string(line) # :nodoc:
  @sequence_property = RiCal::PropertyValue::Integer.new(self, line)
end

#statusObject

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


331
332
333
# File 'lib/ri_cal/properties/journal.rb', line 331

def status
  status_property ? status_property.ruby_value : nil
end

#status=(ruby_value) ⇒ Object

set the value of the STATUS property


325
326
327
# File 'lib/ri_cal/properties/journal.rb', line 325

def status=(ruby_value)
  self.status_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#status_propertyObject

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

purpose (from RFC 2445)

This property defines a short summary or subject for the calendar component.

see RFC 2445 4.8.1.11 pp 80-89


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

def status_property
  @status_property
end

#status_property=(property_value) ⇒ Object

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


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

def status_property=(property_value)
  @status_property = property_value
end

#status_property_from_string(line) ⇒ Object

:nodoc:


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

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

#summaryObject

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


364
365
366
# File 'lib/ri_cal/properties/journal.rb', line 364

def summary
  summary_property ? summary_property.ruby_value : nil
end

#summary=(ruby_value) ⇒ Object

set the value of the SUMMARY property


358
359
360
# File 'lib/ri_cal/properties/journal.rb', line 358

def summary=(ruby_value)
  self.summary_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#summary_propertyObject

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

purpose (from RFC 2445)

This property defines a short summary or subject for the calendar component.

see RFC 2445 4.8.1.12 pp 89-90


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

def summary_property
  @summary_property
end

#summary_property=(property_value) ⇒ Object

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


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

def summary_property=(property_value)
  @summary_property = property_value
end

#summary_property_from_string(line) ⇒ Object

:nodoc:


368
369
370
# File 'lib/ri_cal/properties/journal.rb', line 368

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

#uidObject

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


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

def uid
  uid_property ? uid_property.ruby_value : nil
end

#uid=(ruby_value) ⇒ Object

set the value of the UID property


391
392
393
# File 'lib/ri_cal/properties/journal.rb', line 391

def uid=(ruby_value)
  self.uid_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#uid_propertyObject

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

purpose (from RFC 2445)

This property defines the persistent, globally unique identifier for the calendar component.

see RFC 2445 4.8.4.7 pp 111-112


380
381
382
# File 'lib/ri_cal/properties/journal.rb', line 380

def uid_property
  @uid_property
end

#uid_property=(property_value) ⇒ Object

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


386
387
388
# File 'lib/ri_cal/properties/journal.rb', line 386

def uid_property=(property_value)
  @uid_property = property_value
end

#uid_property_from_string(line) ⇒ Object

:nodoc:


401
402
403
# File 'lib/ri_cal/properties/journal.rb', line 401

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

#urlObject

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


430
431
432
# File 'lib/ri_cal/properties/journal.rb', line 430

def url
  url_property ? url_property.ruby_value : nil
end

#url=(ruby_value) ⇒ Object

set the value of the URL property


424
425
426
# File 'lib/ri_cal/properties/journal.rb', line 424

def url=(ruby_value)
  self.url_property= RiCal::PropertyValue::Uri.convert(self, ruby_value)
end

#url_propertyObject

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

purpose (from RFC 2445)

This property defines a Uniform Resource Locator (URL) associated with the iCalendar object.

see RFC 2445 4.8.4.6 pp 110-111


413
414
415
# File 'lib/ri_cal/properties/journal.rb', line 413

def url_property
  @url_property
end

#url_property=(property_value) ⇒ Object

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


419
420
421
# File 'lib/ri_cal/properties/journal.rb', line 419

def url_property=(property_value)
  @url_property = property_value
end

#url_property_from_string(line) ⇒ Object

:nodoc:


434
435
436
# File 'lib/ri_cal/properties/journal.rb', line 434

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