KickJava   Java API By Example, From Geeks To Geeks.

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


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 VEVENT component.
25  * <p>
26  *
27  * <pre>
28  * 4.6.1 Event Component
29  *
30  * Component Name: &quot;VEVENT&quot;
31  *
32  * Purpose: Provide a grouping of component properties that describe an event.
33  *
34  * Format Definition: A &quot;VEVENT&quot; calendar component is defined by the following
35  * notation:
36  *
37  * eventc = &quot;BEGIN&quot; &quot;:&quot; &quot;VEVENT&quot; CRLF eventprop *alarmc &quot;END&quot; &quot;:&quot; &quot;VEVENT&quot; CRLF
38  *
39  * eventprop = *( ; the following are optional, ; but MUST NOT occur more than
40  * once
41  *
42  * class / created / description / dtstart / geo / last-mod / location /
43  * organizer / priority / dtstamp / seq / status / summary / transp / uid / url /
44  * recurid / ; either 'dtend' or 'duration' may appear in ; a 'eventprop', but
45  * 'dtend' and 'duration' ; MUST NOT occur in the same 'eventprop'
46  *
47  * dtend / duration / ; the following are optional, ; and MAY occur more than
48  * once
49  *
50  * attach / attendee / categories / comment / contact / exdate / exrule /
51  * rstatus / related / resources / rdate / rrule / x-prop )
52  * </pre>
53  *
54  * @author fdietz
55  *
56  */
57 public interface IEvent extends IComponent, ICategoryList, IAttachmentList {
58     
59     /**
60      * @return Returns the dtEnd.
61      */
62     public abstract Calendar JavaDoc getDtEnd();
63
64     public abstract void setDtEnd(Calendar JavaDoc dtEnd);
65
66     /**
67      * @return Returns the location.
68      */
69     public abstract String JavaDoc getLocation();
70
71     public abstract void setLocation(String JavaDoc location);
72
73     /**
74      * @return Returns the transsp.
75      */
76     public abstract String JavaDoc getTranssp();
77
78     public abstract void setTranssp(String JavaDoc transsp);
79
80     /**
81      * @return Returns the dtStart.
82      */
83     public abstract Calendar JavaDoc getDtStart();
84
85     public abstract void setDtStart(Calendar JavaDoc dtStart);
86
87     /**
88      * @return Returns the priority.
89      */
90     public abstract String JavaDoc getPriority();
91
92     public abstract void setPriority(String JavaDoc priority);
93
94     /**
95      * @return Returns the summary.
96      */
97     public abstract String JavaDoc getSummary();
98
99     public abstract void setSummary(String JavaDoc summary);
100
101     /**
102      * @return Returns the description.
103      */
104     public abstract String JavaDoc getDescription();
105
106     public abstract void setDescription(String JavaDoc description);
107
108     /**
109      * @return Returns the url.
110      */
111     public abstract URL JavaDoc getUrl();
112
113     public abstract void setUrl(URL JavaDoc url);
114
115     /**
116      * @return Returns the eventClass.
117      */
118     public abstract String JavaDoc getEventClass();
119
120     public abstract void setEventClass(String JavaDoc eventClass);
121     
122     /**
123      * @return Returns the allDayEvent flag
124      */
125     public abstract boolean isAllDayEvent();
126
127     public abstract void setAllDayEvent(boolean allDayEventFlag);
128     
129     /**
130      * @return Returns the status
131      */
132     public abstract String JavaDoc getStatus();
133     public abstract void setStatus(String JavaDoc status);
134     
135     public abstract IRecurrence getRecurrence();
136     public abstract void setRecurrence(IRecurrence recurrence);
137     
138 }
139
Popular Tags