KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > calendar > store > api > ICalendarStore


1 package org.columba.calendar.store.api;
2
3 import java.util.Calendar JavaDoc;
4 import java.util.Iterator JavaDoc;
5
6 import org.columba.calendar.model.api.IComponentInfo;
7 import org.columba.calendar.model.api.IComponentInfoList;
8 import org.columba.calendar.model.api.IDateRange;
9
10 /**
11  * Calendar store.
12  *
13  * @author fdietz
14  */

15 public interface ICalendarStore {
16
17     IComponentInfo get(Object JavaDoc uid) throws StoreException;
18
19     void add(IComponentInfo calendarModel) throws StoreException;
20
21     void modify(Object JavaDoc uid, IComponentInfo calendarModel) throws StoreException;
22
23     void remove(Object JavaDoc uid) throws StoreException;
24
25     IComponentInfoList getComponentInfoList() throws StoreException;
26
27     IComponentInfoList getComponentInfoList(String JavaDoc calendarId) throws StoreException;
28     
29     Iterator JavaDoc<String JavaDoc> getIdIterator() throws StoreException;
30     
31     Iterator JavaDoc<String JavaDoc> getIdIterator(String JavaDoc calendarId) throws StoreException;
32     
33     boolean exists(Object JavaDoc uid) throws StoreException;
34     
35     /**
36      * Find all components including the specific <code>searchTerm</code> in the summary.
37      *
38      * @param summary
39      * @return iterator of all component IDs
40      * @throws StoreException
41      */

42     Iterator JavaDoc<String JavaDoc> findBySummary(String JavaDoc searchTerm) throws StoreException;
43     
44     /**
45      * Find all components starting at <code>startDate</code>.
46      *
47      * @param startDate
48      * @return iterator of all component IDs
49      * @throws StoreException
50      */

51     Iterator JavaDoc<String JavaDoc> findByStartDate(Calendar JavaDoc startDate) throws StoreException;
52     
53     /**
54      * Find all components in the date range.
55      *
56      * @param dateRange
57      * @return iterator of all component IDs
58      * @throws StoreException
59      */

60     Iterator JavaDoc<String JavaDoc> findByDateRange(IDateRange dateRange) throws StoreException;
61 }
62
Popular Tags