org.opengroupware.jogi.ogo
Interface AppointmentManager

All Known Implementing Classes:

XmlRpcAppointmentManager

public interface AppointmentManager

Manages access to the Appointments on an OpenGroupware.org installation.

Author:

Andreas Rath (teddius), Werner Schuster (murphee)

Method Summary

Appointment	createAppointment(java.util.Date startDate, java.util.Date endDate, java.lang.String name)
void	delete(Appointment appointment)
java.util.Iterator	fetch(java.util.Map fetch_spec) Fetches all Appointments that match the query parameters specified in the Map.
java.util.Iterator	fetchIds(java.util.Map fetch_spec) Fetches all Ids of Appointments that match the query parameters specified in the Map.
Appointment	getById(java.lang.String id)
Appointment	insert(Appointment appointment)
Appointment	insertAppointment(java.util.Date startDate, java.util.Date endDate, java.lang.String name)

Method Detail

getById

public Appointment getById(java.lang.String id)
                    throws OgoException,
                           ConnectionException

Throws:

OgoException

ConnectionException

delete

public void delete(Appointment appointment)
            throws OgoException,
                   ConnectionException

Throws:

OgoException

ConnectionException

createAppointment

public Appointment createAppointment(java.util.Date startDate,
                                     java.util.Date endDate,
                                     java.lang.String name)
                              throws OgoException,
                                     ConnectionException

Throws:

OgoException

ConnectionException

insertAppointment

public Appointment insertAppointment(java.util.Date startDate,
                                     java.util.Date endDate,
                                     java.lang.String name)
                              throws OgoException,
                                     ConnectionException

Throws:

OgoException

ConnectionException

fetchIds

public java.util.Iterator fetchIds(java.util.Map fetch_spec)
                            throws OgoException,
                                   ConnectionException

Fetches all Ids of Appointments that match the query parameters specified in the Map.

Parameters:

fetch_spec - a Map with String keys that specify what Appointments to fetch. Two keys for the Map are "startDate" and "endDate" which take java.util.Date objects as values. these allow to query Appointments after a date and/or before a date. For further keys,refer to the OpenGroupware.org documentation.

Returns:

an Iterator giving access to the resulting Appointments or null if no matching accounts were found.

Throws:

OgoException

ConnectionException

fetch

public java.util.Iterator fetch(java.util.Map fetch_spec)
                         throws OgoException,
                                ConnectionException

Fetches all Appointments that match the query parameters specified in the Map.

Parameters:

fetch_spec - a Map with String keys that specify what Appointments to fetch. Two keys for the Map are "startDate" and "endDate" which take java.util.Date objects as values; these allow to query Appointments after a date and/or before a date. For further keys, refer to the OpenGroupware.org documentation.

Returns:

an Iterator giving access to the resulting Appointment objects or null if no matching accounts were found.

Throws:

OgoException

ConnectionException

insert

public Appointment insert(Appointment appointment)
                   throws OgoException,
                          ConnectionException

Throws:

OgoException

ConnectionException