org.unitedinternet.cosmo.service

Interface CalendarService

All Superinterfaces:

Service

public interface CalendarService
extends Service

Author:

izein

Method Summary

Modifier and Type	Method and Description
ContentItem	findEventByIcalUid(String uid, CollectionItem collection) Find calendar event with a specified icalendar uid.
Set<Item>	findEvents(CollectionItem collection, net.fortuna.ical4j.model.Date rangeStart, net.fortuna.ical4j.model.Date rangeEnd, String timeZoneId, boolean expandRecurringEvents) Find calendar events by time range.
Map<String,List<NoteItem>>	findNoteItemsByIcalUid(Item collection, List<String> uid) Find events by ical uid.
Set<ICalendarItem>	splitCalendarItems(net.fortuna.ical4j.model.Calendar calendar, User cosmoUser) splits the Calendar Object received into different calendar Components>

Methods inherited from interface org.unitedinternet.cosmo.service.Service

destroy, init

Method Detail

findEvents

Set<Item> findEvents(CollectionItem collection,
                     net.fortuna.ical4j.model.Date rangeStart,
                     net.fortuna.ical4j.model.Date rangeEnd,
                     String timeZoneId,
                     boolean expandRecurringEvents)

Find calendar events by time range.

Parameters:

collection - collection to search

rangeStart - time range start

rangeEnd - time range end

timeZoneId - id for timezone; null if not used.

expandRecurringEvents - if true, recurring events will be expanded and each occurrence will be returned as a NoteItemOccurrence.

Returns:

Set set ContentItem objects that contain EventStamps that occur int the given timeRange

findEventByIcalUid

ContentItem findEventByIcalUid(String uid,
                               CollectionItem collection)

Find calendar event with a specified icalendar uid. The icalendar format requires that an event's uid is unique within a calendar.

Parameters:

uid - icalendar uid of calendar event

collection - collection to search

Returns:

calendar event represented by uid and calendar

findNoteItemsByIcalUid

Map<String,List<NoteItem>> findNoteItemsByIcalUid(Item collection,
                                                  List<String> uid)

Find events by ical uid.

Parameters:

collection - Calendar.

uid - The event's uid.

splitCalendarItems

Set<ICalendarItem> splitCalendarItems(net.fortuna.ical4j.model.Calendar calendar,
                                      User cosmoUser)

splits the Calendar Object received into different calendar Components>

Parameters:

calendar - Calendar

User - cosmoUser

Returns:

Set