org.opengroupware.jogi.connect.xmlrpc
Class XmlRpcAppointmentManager

java.lang.Object
  org.opengroupware.jogi.connect.xmlrpc.XmlRpcAppointmentManager

All Implemented Interfaces:

AppointmentManager, java.util.Observer

public class XmlRpcAppointmentManager

extends java.lang.Object

implements java.util.Observer, AppointmentManager

The Appointment Manager handels the creation and the removing of Appointments. It also has the possibility to fetch Appointments with various attributes (eg. startDate, endDate, title, name,...). Furthermore there is an internal cache ("cached_appointments_") to make sure that there is no inconsistence when dealing with Appointment. When an appointment object is modified, there will be an automatic update on the server.

Author:

Andreas Rath (teddius) E-mail: arath@htu.tugraz.at

Field Summary

static java.lang.String	APPOINTMENT_MANAGER_APPOINTMENT_ID
static java.lang.String	APPOINTMENT_MANAGER_DELETE
static java.lang.String	APPOINTMENT_MANAGER_FETCH
static java.lang.String	APPOINTMENT_MANAGER_FETCH_IDS
static java.lang.String	APPOINTMENT_MANAGER_GET_BY_ID
static java.lang.String	APPOINTMENT_MANAGER_INSERT
static java.lang.String	APPOINTMENT_MANAGER_QUALIFIER
static java.lang.String	APPOINTMENT_MANAGER_UPDATE
protected java.util.Map	cached_appointments_
protected OpenGroupWare	openGroupware_
protected XmlRpcCaller	xmlcaller

Constructor Summary

XmlRpcAppointmentManager(XmlRpcCaller xmlcaller, OpenGroupWare ogo)

Method Summary

void	commitUpdate()
void	commitUpdate(Appointment appointment)
Appointment	createAppointment(java.util.Date startDate, java.util.Date endDate, java.lang.String name)
protected XmlRpcAppointment	createNewAppointment(java.util.Map content)
void	delete(Appointment appointment)
void	deleteById(java.lang.String id)
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)
protected XmlRpcAppointment	getCachedAppointment(java.lang.Object obj)
Appointment	insert(Appointment appointment)
Appointment	insertAppointment(java.util.Date startDate, java.util.Date endDate, java.lang.String name)
protected XmlRpcAppointment	receiveAppointment(java.lang.Object app_tmp)
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPOINTMENT_MANAGER_APPOINTMENT_ID

public static final java.lang.String APPOINTMENT_MANAGER_APPOINTMENT_ID

See Also:

Constant Field Values

APPOINTMENT_MANAGER_QUALIFIER

public static final java.lang.String APPOINTMENT_MANAGER_QUALIFIER

See Also:

Constant Field Values

APPOINTMENT_MANAGER_GET_BY_ID

public static final java.lang.String APPOINTMENT_MANAGER_GET_BY_ID

See Also:

Constant Field Values

APPOINTMENT_MANAGER_DELETE

public static final java.lang.String APPOINTMENT_MANAGER_DELETE

See Also:

Constant Field Values

APPOINTMENT_MANAGER_FETCH

public static final java.lang.String APPOINTMENT_MANAGER_FETCH

See Also:

Constant Field Values

APPOINTMENT_MANAGER_INSERT

public static final java.lang.String APPOINTMENT_MANAGER_INSERT

See Also:

Constant Field Values

APPOINTMENT_MANAGER_FETCH_IDS

public static final java.lang.String APPOINTMENT_MANAGER_FETCH_IDS

See Also:

Constant Field Values

APPOINTMENT_MANAGER_UPDATE

public static final java.lang.String APPOINTMENT_MANAGER_UPDATE

See Also:

Constant Field Values

cached_appointments_

protected java.util.Map cached_appointments_

xmlcaller

protected XmlRpcCaller xmlcaller

openGroupware_

protected OpenGroupWare openGroupware_

Constructor Detail

XmlRpcAppointmentManager

public XmlRpcAppointmentManager(XmlRpcCaller xmlcaller,
                                OpenGroupWare ogo)

Method Detail

getById

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

Specified by:

getById in interface AppointmentManager

Throws:

OgoException

ConnectionException

delete

public void delete(Appointment appointment)
            throws OgoException,
                   ConnectionException

Specified by:

delete in interface AppointmentManager

Throws:

OgoException

ConnectionException

deleteById

public void deleteById(java.lang.String id)
                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

Specified by:

createAppointment in interface AppointmentManager

Throws:

OgoException

ConnectionException

insertAppointment

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

Specified by:

insertAppointment in interface AppointmentManager

Throws:

OgoException

ConnectionException

fetchIds

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

Description copied from interface: AppointmentManager

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

Specified by:

fetchIds in interface AppointmentManager

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

Description copied from interface: AppointmentManager

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

Specified by:

fetch in interface AppointmentManager

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

Specified by:

insert in interface AppointmentManager

Throws:

OgoException

ConnectionException

commitUpdate

public void commitUpdate()

commitUpdate

public void commitUpdate(Appointment appointment)
                  throws OgoException,
                         ConnectionException

Throws:

OgoException

ConnectionException

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

receiveAppointment

protected XmlRpcAppointment receiveAppointment(java.lang.Object app_tmp)
                                        throws OgoException,
                                               ConnectionException

Throws:

OgoException

ConnectionException

createNewAppointment

protected XmlRpcAppointment createNewAppointment(java.util.Map content)
                                          throws OgoException,
                                                 ConnectionException

Throws:

OgoException

ConnectionException

getCachedAppointment

protected XmlRpcAppointment getCachedAppointment(java.lang.Object obj)
                                          throws OgoException,
                                                 ConnectionException

Throws:

OgoException

ConnectionException