KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > calendar > model > api > ITodo


1 // The contents of this file are subject to the Mozilla Public License Version
2 // 1.1
3 //(the "License"); you may not use this file except in compliance with the
4 //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 //
6 //Software distributed under the License is distributed on an "AS IS" basis,
7 //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
8 //for the specific language governing rights and
9 //limitations under the License.
10 //
11 //The Original Code is "The Columba Project"
12 //
13 //The Initial Developers of the Original Code are Frederik Dietz and Timo
14 // Stich.
15 //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
16 //
17 //All Rights Reserved.
18 package org.columba.calendar.model.api;
19
20 import java.net.URL JavaDoc;
21 import java.util.Calendar JavaDoc;
22
23 /**
24  * Defines an iCalendar VTODO component.
25  * <p>
26  * <pre>
27  * 4.6.2 To-do Component
28  *
29  * Component Name: VTODO
30  *
31  * Purpose: Provide a grouping of calendar properties that describe a to-do.
32  *
33  * Formal Definition: A "VTODO" calendar component is defined by the following
34  * notation:
35  *
36  * todoc = "BEGIN" ":" "VTODO" CRLF todoprop *alarmc "END" ":" "VTODO" CRLF
37  *
38  * todoprop = *( ; the following are optional, ; but MUST NOT occur more than
39  * once
40  *
41  * class / completed / created / description / dtstamp / dtstart / geo /
42  * last-mod / location / organizer / percent / priority / recurid / seq / status /
43  * summary / uid / url / ; either 'due' or 'duration' may appear in ; a
44  * 'todoprop', but 'due' and 'duration' ; MUST NOT occur in the same 'todoprop'
45  *
46  * due / duration / ; the following are optional, ; and MAY occur more than once
47  *
48  * attach / attendee / categories / comment / contact / exdate / exrule /
49  * rstatus / related / resources / rdate / rrule / x-prop )
50  * </pre>
51  *
52  * @author fdietz
53  *
54  */
55 public interface ITodo extends IComponent, ICategoryList, IAttachmentList {
56
57     public abstract Calendar JavaDoc getDue();
58
59     /**
60      * @return Returns the dtStart.
61      */
62     public abstract Calendar JavaDoc getDtStart();
63
64     /**
65      * @return Returns the priority.
66      */
67     public abstract String JavaDoc getPriority();
68
69     /**
70      * @return Returns the summary.
71      */
72     public abstract String JavaDoc getSummary();
73
74     /**
75      * @return Returns the description.
76      */
77     public abstract String JavaDoc getDescription();
78
79     /**
80      * @return Returns the url.
81      */
82     public abstract URL JavaDoc getUrl();
83
84     /**
85      * @return Returns the eventClass.
86      */
87     public abstract String JavaDoc getEventClass();
88
89 }
90
Popular Tags