Package net.fortuna.ical4j.connector

Interface CalendarCollection

All Superinterfaces:

ObjectCollection<Calendar>

All Known Implementing Classes:

CalDavCalendarCollection, JcrCalendarCollection, LocalCalendarCollection

public interface CalendarCollection
extends ObjectCollection<Calendar>

$Id$ Created on 20/02/2008

Method Summary

Modifier and Type	Method	Description
void	addCalendar(Calendar calendar)	Stores the specified calendar in this collection.
Calendar	export()	Exports the entire collection as a single calendar object.
Calendar	getCalendar(String uid)	Returns the calendar object with the specified UID.
Integer	getMaxAttendeesPerInstance()
String	getMaxDateTime()
Integer	getMaxInstances()
long	getMaxResourceSize()
String	getMinDateTime()
String[]	getSupportedComponentTypes()
MediaType[]	getSupportedMediaTypes()
Calendar	getTimeZone()
void	merge(Calendar calendar)	Merges the specified calendar object with this collecton.
Calendar	removeCalendar(String uid)

Methods inherited from interface net.fortuna.ical4j.connector.ObjectCollection

getComponents, getDescription, getDisplayName

Method Detail

getTimeZone

Calendar getTimeZone()

Returns:

an iCalendar object with exactly one VTIMEZONE component.

getSupportedComponentTypes

String[] getSupportedComponentTypes()

Returns:

an array of component names indicating the type of components supported by the collection.

getSupportedMediaTypes

MediaType[] getSupportedMediaTypes()

Returns:

the media type supported for the calendar object resources contained in a given calendar collection (e.g., iCalendar version 2.0).

getMaxResourceSize

long getMaxResourceSize()

Returns:

a numeric value indicating the maximum size of a resource in octets that the server is willing to accept when a calendar object resource is stored in a calendar collection.

getMinDateTime

String getMinDateTime()

Returns:

a DATE-TIME value indicating the earliest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

getMaxDateTime

String getMaxDateTime()

Returns:

a DATE-TIME value indicating the latest date and time (in UTC) that the server is willing to accept for any DATE or DATE-TIME value in a calendar object resource stored in a calendar collection.

getMaxInstances

Integer getMaxInstances()

Returns:

a numeric value indicating the maximum number of recurrence instances that a calendar object resource stored in a calendar collection can generate.

getMaxAttendeesPerInstance

Integer getMaxAttendeesPerInstance()

Returns:

a numeric value indicating the maximum number of ATTENDEE properties in any instance of a calendar object resource stored in a calendar collection.

addCalendar

void addCalendar(Calendar calendar)
          throws ObjectStoreException,
                 ConstraintViolationException

Stores the specified calendar in this collection.

Parameters:

calendar - a calendar object instance to be added to the collection

Throws:

ObjectStoreException - when an unexpected error occurs (implementation-specific)

ConstraintViolationException - if the specified calendar has no single unique identifier (UID)

getCalendar

Calendar getCalendar(String uid)
              throws ObjectNotFoundException

Returns the calendar object with the specified UID.

Parameters:

uid - the UID associated with the returned calendar

Returns:

a calendar object or null if no calendar with the specified UID exists

Throws:

ObjectNotFoundException

removeCalendar

Calendar removeCalendar(String uid)
                 throws FailedOperationException,
                        ObjectStoreException,
                        ObjectNotFoundException

Parameters:

uid - the UID of the calendar to remove

Returns:

the calendar that was successfully removed from the collection

Throws:

ObjectStoreException - where an unexpected error occurs

FailedOperationException

ObjectNotFoundException

merge

void merge(Calendar calendar)
    throws FailedOperationException,
           ObjectStoreException

Merges the specified calendar object with this collecton. This is done by decomposing the calendar object into a set of objects per unique identifier (UID) and adding these objects to the collection.

Parameters:

calendar - a calendar object instance to merge into the collection

Throws:

FailedOperationException - where the merge operation fails

ObjectStoreException

export

Calendar export()
         throws ObjectStoreException

Exports the entire collection as a single calendar object.

Returns:

a calendar object instance that contains all calendars in the collection

Throws:

ObjectStoreException - where an unexpected error occurs