mirror of
https://github.com/etesync/android
synced 2025-08-04 21:05:17 +00:00
1925 lines
111 KiB
HTML
1925 lines
111 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_51) on Sat Sep 21 17:46:23 EDT 2013 -->
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<TITLE>
|
|
VJournal (biweekly 0.3.1 API)
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2013-09-21">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../syntaxhighlighter.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="VJournal (biweekly 0.3.1 API)";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<script src="doc-files/shCore.js" type="text/javascript"></script> <script src="doc-files/shBrushJava.js" type="text/javascript"></script><HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VJournal.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../biweekly/component/VFreeBusy.html" title="class in biweekly.component"><B>PREV CLASS</B></A>
|
|
<A HREF="../../biweekly/component/VTimezone.html" title="class in biweekly.component"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?biweekly/component/VJournal.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="VJournal.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_biweekly.component.ICalComponent">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
biweekly.component</FONT>
|
|
<BR>
|
|
Class VJournal</H2>
|
|
<PRE>
|
|
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
|
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">biweekly.component.ICalComponent</A>
|
|
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>biweekly.component.VJournal</B>
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <A HREF="../../src-html/biweekly/component/VJournal.html#line.77"><B>VJournal</B></A><DT>extends <A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
<p>
|
|
Defines descriptive text associated with the calendar data.
|
|
</p>
|
|
<p>
|
|
<b>Examples:</b>
|
|
|
|
<pre class="brush:java">
|
|
VJournal journal = new VJournal();
|
|
journal.setSummary("Team Meeting");
|
|
journal.setDescription("The following items were discussed: ...");
|
|
byte[] slides = ...
|
|
journal.addAttachment(new Attachment("application/vnd.ms-powerpoint", slides));
|
|
</pre>
|
|
|
|
</p>
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Michael Angstadt</DD>
|
|
<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-57">RFC 5545 p.57-9</a></dd></DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="fields_inherited_from_class_biweekly.component.ICalComponent"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Fields inherited from class biweekly.component.<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="../../biweekly/component/ICalComponent.html#components">components</A>, <A HREF="../../biweekly/component/ICalComponent.html#properties">properties</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#VJournal()">VJournal</A></B>()</CODE>
|
|
|
|
<BR>
|
|
|
|
Creates a new journal entry.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addAttachment(biweekly.property.Attachment)">addAttachment</A></B>(<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A> attachment)</CODE>
|
|
|
|
<BR>
|
|
Adds an attachment to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addAttendee(biweekly.property.Attendee)">addAttendee</A></B>(<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A> attendee)</CODE>
|
|
|
|
<BR>
|
|
Adds a person who is involved in the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addAttendee(java.lang.String)">addAttendee</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> email)</CODE>
|
|
|
|
<BR>
|
|
Adds a person who is involved in the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addCategories(biweekly.property.Categories)">addCategories</A></B>(<A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A> categories)</CODE>
|
|
|
|
<BR>
|
|
Adds a list of "tags" or "keywords" that describe the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addCategories(java.util.List)">addCategories</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> categories)</CODE>
|
|
|
|
<BR>
|
|
Adds a list of "tags" or "keywords" that describe the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addCategories(java.lang.String...)">addCategories</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... categories)</CODE>
|
|
|
|
<BR>
|
|
Adds a list of "tags" or "keywords" that describe the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addComment(biweekly.property.Comment)">addComment</A></B>(<A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A> comment)</CODE>
|
|
|
|
<BR>
|
|
Adds a comment to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addComment(java.lang.String)">addComment</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> comment)</CODE>
|
|
|
|
<BR>
|
|
Adds a comment to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addContact(biweekly.property.Contact)">addContact</A></B>(<A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A> contact)</CODE>
|
|
|
|
<BR>
|
|
Adds a contact to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addContact(java.lang.String)">addContact</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contact)</CODE>
|
|
|
|
<BR>
|
|
Adds a contact to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addDescription(biweekly.property.Description)">addDescription</A></B>(<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A> description)</CODE>
|
|
|
|
<BR>
|
|
Adds a detailed description to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addDescription(java.lang.String)">addDescription</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> description)</CODE>
|
|
|
|
<BR>
|
|
Adds a detailed description to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addExceptionDates(biweekly.property.ExceptionDates)">addExceptionDates</A></B>(<A HREF="../../biweekly/property/ExceptionDates.html" title="class in biweekly.property">ExceptionDates</A> exceptionDates)</CODE>
|
|
|
|
<BR>
|
|
Adds a list of exceptions to the recurrence rule defined in the journal
|
|
entry (if one is defined).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addExceptionRule(biweekly.property.ExceptionRule)">addExceptionRule</A></B>(<A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A> exceptionRule)</CODE>
|
|
|
|
<BR>
|
|
|
|
Adds an exception for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addExceptionRule(biweekly.util.Recurrence)">addExceptionRule</A></B>(<A HREF="../../biweekly/util/Recurrence.html" title="class in biweekly.util">Recurrence</A> recur)</CODE>
|
|
|
|
<BR>
|
|
|
|
Adds an exception for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addRecurrenceDates(biweekly.property.RecurrenceDates)">addRecurrenceDates</A></B>(<A HREF="../../biweekly/property/RecurrenceDates.html" title="class in biweekly.property">RecurrenceDates</A> recurrenceDates)</CODE>
|
|
|
|
<BR>
|
|
Adds a list of dates/periods that help define the recurrence rule of this
|
|
journal entry (if one is defined).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addRelatedTo(biweekly.property.RelatedTo)">addRelatedTo</A></B>(<A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A> relatedTo)</CODE>
|
|
|
|
<BR>
|
|
Adds a component that the journal entry is related to.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#addRelatedTo(java.lang.String)">addRelatedTo</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uid)</CODE>
|
|
|
|
<BR>
|
|
Adds a component that the journal entry is related to.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getAttachments()">getAttachments</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets any attachments that are associated with the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getAttendees()">getAttendees</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the people who are involved in the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getCategories()">getCategories</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets a list of "tags" or "keywords" that describe the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getClassification()">getClassification</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the level of sensitivity of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getComments()">getComments</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the comments attached to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getContacts()">getContacts</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the contacts associated with the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getCreated()">getCreated</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the date-time that the journal entry was initially created.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getDateStart()">getDateStart</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the date that the journal entry starts.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getDateTimeStamp()">getDateTimeStamp</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getDescriptions()">getDescriptions</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the detailed descriptions to the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/ExceptionDates.html" title="class in biweekly.property">ExceptionDates</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getExceptionDates()">getExceptionDates</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the list of exceptions to the recurrence rule defined in the journal
|
|
entry (if one is defined).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getExceptionRules()">getExceptionRules</A></B>()</CODE>
|
|
|
|
<BR>
|
|
|
|
Gets the exceptions for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getLastModified()">getLastModified</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the date-time that the journal entry was last changed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getOrganizer()">getOrganizer</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the organizer of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/RecurrenceDates.html" title="class in biweekly.property">RecurrenceDates</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getRecurrenceDates()">getRecurrenceDates</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the list of dates/periods that help define the recurrence rule of
|
|
this journal entry (if one is defined).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getRecurrenceId()">getRecurrenceId</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the event is
|
|
recurring and has been modified.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getRecurrenceRule()">getRecurrenceRule</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets how often the journal entry repeats.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getRelatedTo()">getRelatedTo</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the components that the journal entry is related to.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RequestStatus.html" title="class in biweekly.property">RequestStatus</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getRequestStatus()">getRequestStatus</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the response to a scheduling request.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getSequence()">getSequence</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the revision number of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Status.html" title="class in biweekly.property">Status</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getStatus()">getStatus</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the status of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getSummary()">getSummary</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the summary of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getUid()">getUid</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the unique identifier for this journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#getUrl()">getUrl</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets a URL to a resource that contains additional information about the
|
|
journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#incrementSequence()">incrementSequence</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Increments the revision number of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setClassification(biweekly.property.Classification)">setClassification</A></B>(<A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A> classification)</CODE>
|
|
|
|
<BR>
|
|
Sets the level of sensitivity of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setClassification(java.lang.String)">setClassification</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> classification)</CODE>
|
|
|
|
<BR>
|
|
Sets the level of sensitivity of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setCreated(biweekly.property.Created)">setCreated</A></B>(<A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A> created)</CODE>
|
|
|
|
<BR>
|
|
Sets the date-time that the journal entry was initially created.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setCreated(java.util.Date)">setCreated</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> created)</CODE>
|
|
|
|
<BR>
|
|
Sets the date-time that the journal entry was initially created.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setDateStart(java.util.Date)">setDateStart</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> dateStart)</CODE>
|
|
|
|
<BR>
|
|
Sets the date that the journal entry starts.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setDateStart(biweekly.property.DateStart)">setDateStart</A></B>(<A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A> dateStart)</CODE>
|
|
|
|
<BR>
|
|
Sets the date that the journal entry starts.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setDateTimeStamp(java.util.Date)">setDateTimeStamp</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> dateTimeStamp)</CODE>
|
|
|
|
<BR>
|
|
Sets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setDateTimeStamp(biweekly.property.DateTimeStamp)">setDateTimeStamp</A></B>(<A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A> dateTimeStamp)</CODE>
|
|
|
|
<BR>
|
|
Sets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setLastModified(java.util.Date)">setLastModified</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> lastModified)</CODE>
|
|
|
|
<BR>
|
|
Sets the date-time that the journal entry was last changed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setLastModified(biweekly.property.LastModified)">setLastModified</A></B>(<A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A> lastModified)</CODE>
|
|
|
|
<BR>
|
|
Sets the date-time that the journal entry was last changed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setOrganizer(biweekly.property.Organizer)">setOrganizer</A></B>(<A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A> organizer)</CODE>
|
|
|
|
<BR>
|
|
Sets the organizer of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setOrganizer(java.lang.String)">setOrganizer</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> email)</CODE>
|
|
|
|
<BR>
|
|
Sets the organizer of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setRecurrenceId(java.util.Date)">setRecurrenceId</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> originalStartDate)</CODE>
|
|
|
|
<BR>
|
|
Sets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the journal
|
|
entry is recurring and has been modified.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setRecurrenceId(biweekly.property.RecurrenceId)">setRecurrenceId</A></B>(<A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A> recurrenceId)</CODE>
|
|
|
|
<BR>
|
|
Sets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the event is
|
|
recurring and has been modified.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setRecurrenceRule(biweekly.util.Recurrence)">setRecurrenceRule</A></B>(<A HREF="../../biweekly/util/Recurrence.html" title="class in biweekly.util">Recurrence</A> recur)</CODE>
|
|
|
|
<BR>
|
|
Sets how often the journal entry repeats.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setRecurrenceRule(biweekly.property.RecurrenceRule)">setRecurrenceRule</A></B>(<A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A> recurrenceRule)</CODE>
|
|
|
|
<BR>
|
|
Sets how often the journal entry repeats.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setRequestStatus(biweekly.property.RequestStatus)">setRequestStatus</A></B>(<A HREF="../../biweekly/property/RequestStatus.html" title="class in biweekly.property">RequestStatus</A> requestStatus)</CODE>
|
|
|
|
<BR>
|
|
Sets the response to a scheduling request.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setSequence(java.lang.Integer)">setSequence</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A> sequence)</CODE>
|
|
|
|
<BR>
|
|
Sets the revision number of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setSequence(biweekly.property.Sequence)">setSequence</A></B>(<A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A> sequence)</CODE>
|
|
|
|
<BR>
|
|
Sets the revision number of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setStatus(biweekly.property.Status)">setStatus</A></B>(<A HREF="../../biweekly/property/Status.html" title="class in biweekly.property">Status</A> status)</CODE>
|
|
|
|
<BR>
|
|
Sets the status of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setSummary(java.lang.String)">setSummary</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> summary)</CODE>
|
|
|
|
<BR>
|
|
Sets the summary of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setSummary(biweekly.property.Summary)">setSummary</A></B>(<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> summary)</CODE>
|
|
|
|
<BR>
|
|
Sets the summary of the journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setUid(java.lang.String)">setUid</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uid)</CODE>
|
|
|
|
<BR>
|
|
Sets the unique identifier for this journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setUid(biweekly.property.Uid)">setUid</A></B>(<A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A> uid)</CODE>
|
|
|
|
<BR>
|
|
Sets the unique identifier for this journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setUrl(java.lang.String)">setUrl</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url)</CODE>
|
|
|
|
<BR>
|
|
Sets a URL to a resource that contains additional information about the
|
|
journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#setUrl(biweekly.property.Url)">setUrl</A></B>(<A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A> url)</CODE>
|
|
|
|
<BR>
|
|
Sets a URL to a resource that contains additional information about the
|
|
journal entry.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../biweekly/component/VJournal.html#validate(java.util.List, java.util.List)">validate</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>> components,
|
|
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> warnings)</CODE>
|
|
|
|
<BR>
|
|
Checks the component for data consistency problems or deviations from the
|
|
spec.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_biweekly.component.ICalComponent"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class biweekly.component.<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="../../biweekly/component/ICalComponent.html#addComponent(biweekly.component.ICalComponent)">addComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalComponent(java.lang.String)">addExperimentalComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalProperty(java.lang.String, biweekly.ICalDataType, java.lang.String)">addExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#addExperimentalProperty(java.lang.String, java.lang.String)">addExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#addProperty(biweekly.property.ICalProperty)">addProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#checkOptionalCardinality(java.util.List, java.lang.Class...)">checkOptionalCardinality</A>, <A HREF="../../biweekly/component/ICalComponent.html#checkRequiredCardinality(java.util.List, java.lang.Class...)">checkRequiredCardinality</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponent(java.lang.Class)">getComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponents()">getComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getComponents(java.lang.Class)">getComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponent(java.lang.String)">getExperimentalComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponents()">getExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalComponents(java.lang.String)">getExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperties()">getExperimentalProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperties(java.lang.String)">getExperimentalProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getExperimentalProperty(java.lang.String)">getExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperties()">getProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperties(java.lang.Class)">getProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#getProperty(java.lang.Class)">getProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeExperimentalComponents(java.lang.String)">removeExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeExperimentalProperty(java.lang.String)">removeExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#removeProperties(java.lang.Class)">removeProperties</A>, <A HREF="../../biweekly/component/ICalComponent.html#setComponent(java.lang.Class, T)">setComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#setComponent(biweekly.component.ICalComponent)">setComponent</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalComponents(java.lang.String)">setExperimentalComponents</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalProperty(java.lang.String, biweekly.ICalDataType, java.lang.String)">setExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setExperimentalProperty(java.lang.String, java.lang.String)">setExperimentalProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setProperty(java.lang.Class, T)">setProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#setProperty(biweekly.property.ICalProperty)">setProperty</A>, <A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List)">validate</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="VJournal()"><!-- --></A><H3>
|
|
VJournal</H3>
|
|
<PRE>
|
|
public <A HREF="../../src-html/biweekly/component/VJournal.html#line.92"><B>VJournal</B></A>()</PRE>
|
|
<DL>
|
|
<DD><p>
|
|
Creates a new journal entry.
|
|
</p>
|
|
<p>
|
|
The following properties are auto-generated on object creation. These
|
|
properties <b>must</b> be present in order for the journal entry to be
|
|
valid:
|
|
<ul>
|
|
<li><A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property"><CODE>Uid</CODE></A> - Set to a UUID.</li>
|
|
<li><A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property"><CODE>DateTimeStamp</CODE></A> - Set to the current date-time.</li>
|
|
</ul>
|
|
</p>
|
|
<P>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="getUid()"><!-- --></A><H3>
|
|
getUid</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.104"><B>getUid</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the unique identifier for this journal entry. This component object
|
|
comes populated with a UID on creation. This is a <b>required</b>
|
|
property.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the UID or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-117">RFC 5545 p.117-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUid(biweekly.property.Uid)"><!-- --></A><H3>
|
|
setUid</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.115"><B>setUid</B></A>(<A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A> uid)</PRE>
|
|
<DL>
|
|
<DD>Sets the unique identifier for this journal entry. This component object
|
|
comes populated with a UID on creation. This is a <b>required</b>
|
|
property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>uid</CODE> - the UID or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-117">RFC 5545 p.117-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUid(java.lang.String)"><!-- --></A><H3>
|
|
setUid</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property">Uid</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.127"><B>setUid</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uid)</PRE>
|
|
<DL>
|
|
<DD>Sets the unique identifier for this journal entry. This component object
|
|
comes populated with a UID on creation. This is a <b>required</b>
|
|
property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>uid</CODE> - the UID or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-117">RFC 5545 p.117-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDateTimeStamp()"><!-- --></A><H3>
|
|
getDateTimeStamp</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.143"><B>getDateTimeStamp</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information). This journal entry object comes populated with a
|
|
<A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property"><CODE>DateTimeStamp</CODE></A> property that is set to the current time. This is a
|
|
<b>required</b> property.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the date time stamp or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-137">RFC 5545 p.137-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDateTimeStamp(biweekly.property.DateTimeStamp)"><!-- --></A><H3>
|
|
setDateTimeStamp</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.157"><B>setDateTimeStamp</B></A>(<A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A> dateTimeStamp)</PRE>
|
|
<DL>
|
|
<DD>Sets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information). This journal entry object comes populated with a
|
|
<A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property"><CODE>DateTimeStamp</CODE></A> property that is set to the current time. This is a
|
|
<b>required</b> property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dateTimeStamp</CODE> - the date time stamp or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-137">RFC 5545 p.137-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDateTimeStamp(java.util.Date)"><!-- --></A><H3>
|
|
setDateTimeStamp</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property">DateTimeStamp</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.172"><B>setDateTimeStamp</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> dateTimeStamp)</PRE>
|
|
<DL>
|
|
<DD>Sets either (a) the creation date of the iCalendar object (if the
|
|
<A HREF="../../biweekly/property/Method.html" title="class in biweekly.property"><CODE>Method</CODE></A> property is defined) or (b) the date that the journal
|
|
entry was last modified (the <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property"><CODE>LastModified</CODE></A> property also holds
|
|
this information). This journal entry object comes populated with a
|
|
<A HREF="../../biweekly/property/DateTimeStamp.html" title="class in biweekly.property"><CODE>DateTimeStamp</CODE></A> property that is set to the current time. This is a
|
|
<b>required</b> property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dateTimeStamp</CODE> - the date time stamp or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-137">RFC 5545 p.137-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getClassification()"><!-- --></A><H3>
|
|
getClassification</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.184"><B>getClassification</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the level of sensitivity of the journal entry. If not specified, the
|
|
data within the journal entry should be considered "public".
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the classification level or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-82">RFC 5545 p.82-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setClassification(biweekly.property.Classification)"><!-- --></A><H3>
|
|
setClassification</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.194"><B>setClassification</B></A>(<A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A> classification)</PRE>
|
|
<DL>
|
|
<DD>Sets the level of sensitivity of the journal entry. If not specified, the
|
|
data within the journal entry should be considered "public".
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>classification</CODE> - the classification level or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-82">RFC 5545 p.82-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setClassification(java.lang.String)"><!-- --></A><H3>
|
|
setClassification</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Classification.html" title="class in biweekly.property">Classification</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.206"><B>setClassification</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> classification)</PRE>
|
|
<DL>
|
|
<DD>Sets the level of sensitivity of the journal entry. If not specified, the
|
|
data within the journal entry should be considered "public".
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>classification</CODE> - the classification level (e.g. "CONFIDENTIAL") or
|
|
null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-82">RFC 5545 p.82-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getCreated()"><!-- --></A><H3>
|
|
getCreated</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.217"><B>getCreated</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the date-time that the journal entry was initially created.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the creation date-time or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-136">RFC 5545 p.136</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCreated(biweekly.property.Created)"><!-- --></A><H3>
|
|
setCreated</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.226"><B>setCreated</B></A>(<A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A> created)</PRE>
|
|
<DL>
|
|
<DD>Sets the date-time that the journal entry was initially created.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>created</CODE> - the creation date-time or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-136">RFC 5545 p.136</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCreated(java.util.Date)"><!-- --></A><H3>
|
|
setCreated</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Created.html" title="class in biweekly.property">Created</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.236"><B>setCreated</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> created)</PRE>
|
|
<DL>
|
|
<DD>Sets the date-time that the journal entry was initially created.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>created</CODE> - the creation date-time or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-136">RFC 5545 p.136</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDateStart()"><!-- --></A><H3>
|
|
getDateStart</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.247"><B>getDateStart</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the date that the journal entry starts.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the start date or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-97">RFC 5545 p.97-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDateStart(biweekly.property.DateStart)"><!-- --></A><H3>
|
|
setDateStart</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.256"><B>setDateStart</B></A>(<A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A> dateStart)</PRE>
|
|
<DL>
|
|
<DD>Sets the date that the journal entry starts.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dateStart</CODE> - the start date or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-97">RFC 5545 p.97-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDateStart(java.util.Date)"><!-- --></A><H3>
|
|
setDateStart</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property">DateStart</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.266"><B>setDateStart</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> dateStart)</PRE>
|
|
<DL>
|
|
<DD>Sets the date that the journal entry starts.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dateStart</CODE> - the start date or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-97">RFC 5545 p.97-8</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLastModified()"><!-- --></A><H3>
|
|
getLastModified</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.277"><B>getLastModified</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the date-time that the journal entry was last changed.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the last modified date or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLastModified(biweekly.property.LastModified)"><!-- --></A><H3>
|
|
setLastModified</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.286"><B>setLastModified</B></A>(<A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A> lastModified)</PRE>
|
|
<DL>
|
|
<DD>Sets the date-time that the journal entry was last changed.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lastModified</CODE> - the last modified date or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLastModified(java.util.Date)"><!-- --></A><H3>
|
|
setLastModified</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/LastModified.html" title="class in biweekly.property">LastModified</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.296"><B>setLastModified</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> lastModified)</PRE>
|
|
<DL>
|
|
<DD>Sets the date-time that the journal entry was last changed.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lastModified</CODE> - the last modified date or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getOrganizer()"><!-- --></A><H3>
|
|
getOrganizer</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.307"><B>getOrganizer</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the organizer of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the organizer or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-111">RFC 5545 p.111-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setOrganizer(biweekly.property.Organizer)"><!-- --></A><H3>
|
|
setOrganizer</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.316"><B>setOrganizer</B></A>(<A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A> organizer)</PRE>
|
|
<DL>
|
|
<DD>Sets the organizer of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>organizer</CODE> - the organizer or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-111">RFC 5545 p.111-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setOrganizer(java.lang.String)"><!-- --></A><H3>
|
|
setOrganizer</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Organizer.html" title="class in biweekly.property">Organizer</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.327"><B>setOrganizer</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> email)</PRE>
|
|
<DL>
|
|
<DD>Sets the organizer of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>email</CODE> - the organizer's email address (e.g. "johndoe@example.com")
|
|
or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-111">RFC 5545 p.111-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRecurrenceId()"><!-- --></A><H3>
|
|
getRecurrenceId</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.341"><B>getRecurrenceId</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the event is
|
|
recurring and has been modified. Used in conjunction with the <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property"><CODE>Uid</CODE></A>
|
|
and <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property"><CODE>Sequence</CODE></A> properties to uniquely identify a recurrence
|
|
instance.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the recurrence ID or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-112">RFC 5545 p.112-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRecurrenceId(biweekly.property.RecurrenceId)"><!-- --></A><H3>
|
|
setRecurrenceId</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.353"><B>setRecurrenceId</B></A>(<A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A> recurrenceId)</PRE>
|
|
<DL>
|
|
<DD>Sets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the event is
|
|
recurring and has been modified. Used in conjunction with the <A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property"><CODE>Uid</CODE></A>
|
|
and <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property"><CODE>Sequence</CODE></A> properties to uniquely identify a recurrence
|
|
instance.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>recurrenceId</CODE> - the recurrence ID or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-112">RFC 5545 p.112-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRecurrenceId(java.util.Date)"><!-- --></A><H3>
|
|
setRecurrenceId</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RecurrenceId.html" title="class in biweekly.property">RecurrenceId</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.366"><B>setRecurrenceId</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> originalStartDate)</PRE>
|
|
<DL>
|
|
<DD>Sets the original value of the <A HREF="../../biweekly/property/DateStart.html" title="class in biweekly.property"><CODE>DateStart</CODE></A> property if the journal
|
|
entry is recurring and has been modified. Used in conjunction with the
|
|
<A HREF="../../biweekly/property/Uid.html" title="class in biweekly.property"><CODE>Uid</CODE></A> and <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property"><CODE>Sequence</CODE></A> properties to uniquely identify a
|
|
recurrence instance.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>originalStartDate</CODE> - the original start date or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-112">RFC 5545 p.112-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSequence()"><!-- --></A><H3>
|
|
getSequence</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.378"><B>getSequence</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the revision number of the journal entry. The organizer can
|
|
increment this number every time he or she makes a significant change.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the sequence number<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSequence(biweekly.property.Sequence)"><!-- --></A><H3>
|
|
setSequence</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.388"><B>setSequence</B></A>(<A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A> sequence)</PRE>
|
|
<DL>
|
|
<DD>Sets the revision number of the journal entry. The organizer can
|
|
increment this number every time he or she makes a significant change.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the sequence number<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSequence(java.lang.Integer)"><!-- --></A><H3>
|
|
setSequence</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Sequence.html" title="class in biweekly.property">Sequence</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.399"><B>setSequence</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A> sequence)</PRE>
|
|
<DL>
|
|
<DD>Sets the revision number of the journal entry. The organizer can
|
|
increment this number every time he or she makes a significant change.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the sequence number
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="incrementSequence()"><!-- --></A><H3>
|
|
incrementSequence</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.410"><B>incrementSequence</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Increments the revision number of the journal entry. The organizer can
|
|
increment this number every time he or she makes a significant change.
|
|
<P>
|
|
<DD><DL>
|
|
<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-138">RFC 5545 p.138-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getStatus()"><!-- --></A><H3>
|
|
getStatus</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Status.html" title="class in biweekly.property">Status</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.424"><B>getStatus</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the status of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the status or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-92">RFC 5545 p.92-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setStatus(biweekly.property.Status)"><!-- --></A><H3>
|
|
setStatus</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.441"><B>setStatus</B></A>(<A HREF="../../biweekly/property/Status.html" title="class in biweekly.property">Status</A> status)</PRE>
|
|
<DL>
|
|
<DD>Sets the status of the journal entry.
|
|
<p>
|
|
Valid journal status codes are:
|
|
<ul>
|
|
<li>DRAFT</li>
|
|
<li>FINAL</li>
|
|
<li>CANCELLED</li>
|
|
</ul>
|
|
</p>
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>status</CODE> - the status or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-92">RFC 5545 p.92-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSummary()"><!-- --></A><H3>
|
|
getSummary</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.450"><B>getSummary</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the summary of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the summary or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSummary(biweekly.property.Summary)"><!-- --></A><H3>
|
|
setSummary</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.459"><B>setSummary</B></A>(<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> summary)</PRE>
|
|
<DL>
|
|
<DD>Sets the summary of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>summary</CODE> - the summary or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSummary(java.lang.String)"><!-- --></A><H3>
|
|
setSummary</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property">Summary</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.469"><B>setSummary</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> summary)</PRE>
|
|
<DL>
|
|
<DD>Sets the summary of the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>summary</CODE> - the summary or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-93">RFC 5545 p.93-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getUrl()"><!-- --></A><H3>
|
|
getUrl</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.481"><B>getUrl</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets a URL to a resource that contains additional information about the
|
|
journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the URL or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-116">RFC 5545 p.116-7</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUrl(biweekly.property.Url)"><!-- --></A><H3>
|
|
setUrl</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.491"><B>setUrl</B></A>(<A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A> url)</PRE>
|
|
<DL>
|
|
<DD>Sets a URL to a resource that contains additional information about the
|
|
journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-116">RFC 5545 p.116-7</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUrl(java.lang.String)"><!-- --></A><H3>
|
|
setUrl</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Url.html" title="class in biweekly.property">Url</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.503"><B>setUrl</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url)</PRE>
|
|
<DL>
|
|
<DD>Sets a URL to a resource that contains additional information about the
|
|
journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL (e.g. "http://example.com/resource.ics") or null to
|
|
remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-116">RFC 5545 p.116-7</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRecurrenceRule()"><!-- --></A><H3>
|
|
getRecurrenceRule</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.514"><B>getRecurrenceRule</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets how often the journal entry repeats.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the recurrence rule or null if not set<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-122">RFC 5545 p.122-32</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRecurrenceRule(biweekly.util.Recurrence)"><!-- --></A><H3>
|
|
setRecurrenceRule</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.524"><B>setRecurrenceRule</B></A>(<A HREF="../../biweekly/util/Recurrence.html" title="class in biweekly.util">Recurrence</A> recur)</PRE>
|
|
<DL>
|
|
<DD>Sets how often the journal entry repeats.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>recur</CODE> - the recurrence rule or null to remove
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-122">RFC 5545 p.122-32</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRecurrenceRule(biweekly.property.RecurrenceRule)"><!-- --></A><H3>
|
|
setRecurrenceRule</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.535"><B>setRecurrenceRule</B></A>(<A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property">RecurrenceRule</A> recurrenceRule)</PRE>
|
|
<DL>
|
|
<DD>Sets how often the journal entry repeats.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>recurrenceRule</CODE> - the recurrence rule or null to remove<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-122">RFC 5545 p.122-32</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAttachments()"><!-- --></A><H3>
|
|
getAttachments</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.544"><B>getAttachments</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets any attachments that are associated with the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the attachments<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-80">RFC 5545 p.80-1</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addAttachment(biweekly.property.Attachment)"><!-- --></A><H3>
|
|
addAttachment</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.553"><B>addAttachment</B></A>(<A HREF="../../biweekly/property/Attachment.html" title="class in biweekly.property">Attachment</A> attachment)</PRE>
|
|
<DL>
|
|
<DD>Adds an attachment to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>attachment</CODE> - the attachment to add<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-80">RFC 5545 p.80-1</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAttendees()"><!-- --></A><H3>
|
|
getAttendees</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.562"><B>getAttendees</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the people who are involved in the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the attendees<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-107">RFC 5545 p.107-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addAttendee(biweekly.property.Attendee)"><!-- --></A><H3>
|
|
addAttendee</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.571"><B>addAttendee</B></A>(<A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A> attendee)</PRE>
|
|
<DL>
|
|
<DD>Adds a person who is involved in the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>attendee</CODE> - the attendee<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-107">RFC 5545 p.107-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addAttendee(java.lang.String)"><!-- --></A><H3>
|
|
addAttendee</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Attendee.html" title="class in biweekly.property">Attendee</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.581"><B>addAttendee</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> email)</PRE>
|
|
<DL>
|
|
<DD>Adds a person who is involved in the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>email</CODE> - the attendee's email address
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-107">RFC 5545 p.107-9</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getCategories()"><!-- --></A><H3>
|
|
getCategories</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.592"><B>getCategories</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets a list of "tags" or "keywords" that describe the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the categories<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-81">RFC 5545 p.81-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addCategories(biweekly.property.Categories)"><!-- --></A><H3>
|
|
addCategories</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.602"><B>addCategories</B></A>(<A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A> categories)</PRE>
|
|
<DL>
|
|
<DD>Adds a list of "tags" or "keywords" that describe the journal entry. Note
|
|
that a single property can hold multiple keywords.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>categories</CODE> - the categories to add<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-81">RFC 5545 p.81-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addCategories(java.lang.String...)"><!-- --></A><H3>
|
|
addCategories</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.612"><B>addCategories</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... categories)</PRE>
|
|
<DL>
|
|
<DD>Adds a list of "tags" or "keywords" that describe the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>categories</CODE> - the categories to add
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-81">RFC 5545 p.81-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addCategories(java.util.List)"><!-- --></A><H3>
|
|
addCategories</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Categories.html" title="class in biweekly.property">Categories</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.624"><B>addCategories</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> categories)</PRE>
|
|
<DL>
|
|
<DD>Adds a list of "tags" or "keywords" that describe the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>categories</CODE> - the categories to add
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-81">RFC 5545 p.81-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getComments()"><!-- --></A><H3>
|
|
getComments</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.635"><B>getComments</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the comments attached to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the comments<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-83">RFC 5545 p.83-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addComment(biweekly.property.Comment)"><!-- --></A><H3>
|
|
addComment</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.644"><B>addComment</B></A>(<A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A> comment)</PRE>
|
|
<DL>
|
|
<DD>Adds a comment to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>comment</CODE> - the comment to add<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-83">RFC 5545 p.83-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addComment(java.lang.String)"><!-- --></A><H3>
|
|
addComment</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Comment.html" title="class in biweekly.property">Comment</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.654"><B>addComment</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> comment)</PRE>
|
|
<DL>
|
|
<DD>Adds a comment to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>comment</CODE> - the comment to add
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-83">RFC 5545 p.83-4</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getContacts()"><!-- --></A><H3>
|
|
getContacts</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.665"><B>getContacts</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the contacts associated with the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the contacts<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-109">RFC 5545 p.109-11</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addContact(biweekly.property.Contact)"><!-- --></A><H3>
|
|
addContact</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.674"><B>addContact</B></A>(<A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A> contact)</PRE>
|
|
<DL>
|
|
<DD>Adds a contact to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>contact</CODE> - the contact<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-109">RFC 5545 p.109-11</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addContact(java.lang.String)"><!-- --></A><H3>
|
|
addContact</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Contact.html" title="class in biweekly.property">Contact</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.684"><B>addContact</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contact)</PRE>
|
|
<DL>
|
|
<DD>Adds a contact to the journal entry.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>contact</CODE> - the contact (e.g. "ACME Co - (123) 555-1234")
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-109">RFC 5545 p.109-11</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDescriptions()"><!-- --></A><H3>
|
|
getDescriptions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.697"><B>getDescriptions</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the detailed descriptions to the journal entry. The descriptions
|
|
should be a more detailed version of the one provided by the
|
|
<A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A> property.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the descriptions<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addDescription(biweekly.property.Description)"><!-- --></A><H3>
|
|
addDescription</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.708"><B>addDescription</B></A>(<A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A> description)</PRE>
|
|
<DL>
|
|
<DD>Adds a detailed description to the journal entry. The description should
|
|
be a more detailed version of the one provided by the <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A>
|
|
property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>description</CODE> - the description<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addDescription(java.lang.String)"><!-- --></A><H3>
|
|
addDescription</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/Description.html" title="class in biweekly.property">Description</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.720"><B>addDescription</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> description)</PRE>
|
|
<DL>
|
|
<DD>Adds a detailed description to the journal entry. The description should
|
|
be a more detailed version of the one provided by the <A HREF="../../biweekly/property/Summary.html" title="class in biweekly.property"><CODE>Summary</CODE></A>
|
|
property.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>description</CODE> - the description
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-84">RFC 5545 p.84-5</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getExceptionDates()"><!-- --></A><H3>
|
|
getExceptionDates</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/ExceptionDates.html" title="class in biweekly.property">ExceptionDates</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.732"><B>getExceptionDates</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the list of exceptions to the recurrence rule defined in the journal
|
|
entry (if one is defined).
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the list of exceptions<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-118">RFC 5545 p.118-20</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addExceptionDates(biweekly.property.ExceptionDates)"><!-- --></A><H3>
|
|
addExceptionDates</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.743"><B>addExceptionDates</B></A>(<A HREF="../../biweekly/property/ExceptionDates.html" title="class in biweekly.property">ExceptionDates</A> exceptionDates)</PRE>
|
|
<DL>
|
|
<DD>Adds a list of exceptions to the recurrence rule defined in the journal
|
|
entry (if one is defined). Note that this property can contain multiple
|
|
dates.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>exceptionDates</CODE> - the list of exceptions<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-118">RFC 5545 p.118-20</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRelatedTo()"><!-- --></A><H3>
|
|
getRelatedTo</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.752"><B>getRelatedTo</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the components that the journal entry is related to.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the relationships<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-115">RFC 5545 p.115-6</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addRelatedTo(biweekly.property.RelatedTo)"><!-- --></A><H3>
|
|
addRelatedTo</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.761"><B>addRelatedTo</B></A>(<A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A> relatedTo)</PRE>
|
|
<DL>
|
|
<DD>Adds a component that the journal entry is related to.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>relatedTo</CODE> - the relationship<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-115">RFC 5545 p.115-6</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addRelatedTo(java.lang.String)"><!-- --></A><H3>
|
|
addRelatedTo</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RelatedTo.html" title="class in biweekly.property">RelatedTo</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.781"><B>addRelatedTo</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uid)</PRE>
|
|
<DL>
|
|
<DD>Adds a component that the journal entry is related to.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>uid</CODE> - the UID of the other component
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-115">RFC 5545 p.115-6</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRecurrenceDates()"><!-- --></A><H3>
|
|
getRecurrenceDates</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/RecurrenceDates.html" title="class in biweekly.property">RecurrenceDates</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.793"><B>getRecurrenceDates</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the list of dates/periods that help define the recurrence rule of
|
|
this journal entry (if one is defined).
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the recurrence dates<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-120">RFC 5545 p.120-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addRecurrenceDates(biweekly.property.RecurrenceDates)"><!-- --></A><H3>
|
|
addRecurrenceDates</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.803"><B>addRecurrenceDates</B></A>(<A HREF="../../biweekly/property/RecurrenceDates.html" title="class in biweekly.property">RecurrenceDates</A> recurrenceDates)</PRE>
|
|
<DL>
|
|
<DD>Adds a list of dates/periods that help define the recurrence rule of this
|
|
journal entry (if one is defined).
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>recurrenceDates</CODE> - the recurrence dates<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-120">RFC 5545 p.120-2</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRequestStatus()"><!-- --></A><H3>
|
|
getRequestStatus</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/RequestStatus.html" title="class in biweekly.property">RequestStatus</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.812"><B>getRequestStatus</B></A>()</PRE>
|
|
<DL>
|
|
<DD>Gets the response to a scheduling request.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the response<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-141">RFC 5545 p.141-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRequestStatus(biweekly.property.RequestStatus)"><!-- --></A><H3>
|
|
setRequestStatus</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.821"><B>setRequestStatus</B></A>(<A HREF="../../biweekly/property/RequestStatus.html" title="class in biweekly.property">RequestStatus</A> requestStatus)</PRE>
|
|
<DL>
|
|
<DD>Sets the response to a scheduling request.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>requestStatus</CODE> - the response<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc5545#page-141">RFC 5545 p.141-3</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getExceptionRules()"><!-- --></A><H3>
|
|
getExceptionRules</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A>> <A HREF="../../src-html/biweekly/component/VJournal.html#line.836"><B>getExceptionRules</B></A>()</PRE>
|
|
<DL>
|
|
<DD><p>
|
|
Gets the exceptions for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.
|
|
</p>
|
|
<p>
|
|
Note that this property has been removed from the latest version of the
|
|
iCal specification. Its use should be avoided.
|
|
</p>
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the exception rules<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc2445#page-114">RFC 2445 p.114-15</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addExceptionRule(biweekly.util.Recurrence)"><!-- --></A><H3>
|
|
addExceptionRule</H3>
|
|
<PRE>
|
|
public <A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A> <A HREF="../../src-html/biweekly/component/VJournal.html#line.852"><B>addExceptionRule</B></A>(<A HREF="../../biweekly/util/Recurrence.html" title="class in biweekly.util">Recurrence</A> recur)</PRE>
|
|
<DL>
|
|
<DD><p>
|
|
Adds an exception for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.
|
|
</p>
|
|
<p>
|
|
Note that this property has been removed from the latest version of the
|
|
iCal specification. Its use should be avoided.
|
|
</p>
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>recur</CODE> - the exception rule to add
|
|
<DT><B>Returns:</B><DD>the property that was created<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc2445#page-114">RFC 2445 p.114-15</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addExceptionRule(biweekly.property.ExceptionRule)"><!-- --></A><H3>
|
|
addExceptionRule</H3>
|
|
<PRE>
|
|
public void <A HREF="../../src-html/biweekly/component/VJournal.html#line.869"><B>addExceptionRule</B></A>(<A HREF="../../biweekly/property/ExceptionRule.html" title="class in biweekly.property">ExceptionRule</A> exceptionRule)</PRE>
|
|
<DL>
|
|
<DD><p>
|
|
Adds an exception for the <A HREF="../../biweekly/property/RecurrenceRule.html" title="class in biweekly.property"><CODE>RecurrenceRule</CODE></A> property.
|
|
</p>
|
|
<p>
|
|
Note that this property has been removed from the latest version of the
|
|
iCal specification. Its use should be avoided.
|
|
</p>
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>exceptionRule</CODE> - the exception rule to add<dt><b>Specification Reference:</b></dt><dd><a href="http://tools.ietf.org/html/rfc2445#page-114">RFC 2445 p.114-15</a></dd></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="validate(java.util.List, java.util.List)"><!-- --></A><H3>
|
|
validate</H3>
|
|
<PRE>
|
|
protected void <A HREF="../../src-html/biweekly/component/VJournal.html#line.875"><B>validate</B></A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A>> components,
|
|
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> warnings)</PRE>
|
|
<DL>
|
|
<DD><B>Description copied from class: <CODE><A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List, java.util.List)">ICalComponent</A></CODE></B></DD>
|
|
<DD>Checks the component for data consistency problems or deviations from the
|
|
spec. Meant to be overridden by child classes.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="../../biweekly/component/ICalComponent.html#validate(java.util.List, java.util.List)">validate</A></CODE> in class <CODE><A HREF="../../biweekly/component/ICalComponent.html" title="class in biweekly.component">ICalComponent</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>components</CODE> - the hierarchy of components that the component belongs
|
|
to<DD><CODE>warnings</CODE> - the list to add the warnings to</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VJournal.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["gutter"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.defaults["toolbar"] = false; SyntaxHighlighter.all(); </script></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../biweekly/component/VFreeBusy.html" title="class in biweekly.component"><B>PREV CLASS</B></A>
|
|
<A HREF="../../biweekly/component/VTimezone.html" title="class in biweekly.component"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?biweekly/component/VJournal.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="VJournal.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_biweekly.component.ICalComponent">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2013 Michael Angstadt. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|