org.opengroupware.jogi.connect.xmlrpc
Class XmlRpcAppointment

java.lang.Object
  java.util.Observable
      org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument
          org.opengroupware.jogi.connect.xmlrpc.XmlRpcAppointment

All Implemented Interfaces:

Appointment

public class XmlRpcAppointment

extends XmlRpcBaseDocument

implements Appointment

The Appointment class makes the modification of the attributes of an Appointment available. (eg. startDate, endDate, name, title,...)

Author:

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

Field Summary

static java.lang.String	APPOINTMENT_COMMENT
static java.lang.String	APPOINTMENT_CYCLE_END_DATE
static java.lang.String	APPOINTMENT_END_DATE
static java.lang.String	APPOINTMENT_ID
static java.lang.String	APPOINTMENT_LOCATION
static java.lang.String	APPOINTMENT_NAME
static java.lang.String	APPOINTMENT_OWNER
static java.lang.String	APPOINTMENT_OWNER_ID
static java.lang.String	APPOINTMENT_OWNER_LOGIN
static java.lang.String	APPOINTMENT_PARTICIPANTS
static java.lang.String	APPOINTMENT_START_DATE
static java.lang.String	APPOINTMENT_TITLE
static java.lang.String	APPOINTMENT_TYPE
protected OpenGroupWare	openGroupware_
protected java.lang.String	update_key_
protected XmlRpcCaller	xmlcaller_

Fields inherited from class org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument

content_, KEY_ID

Constructor Summary

protected

XmlRpcAppointment(java.util.Date start_date, java.util.Date end_date, java.lang.String title, OpenGroupWare ogo)

Method Summary

void	addParticipant(Person person)
protected boolean	checkNewContent(java.util.Map new_content) This method checks whether the provided Map contains a valid document.
java.lang.String	getComment()
java.util.Date	getCycleEndDate()
java.util.Date	getEndDate()
java.lang.String	getId()
java.lang.String	getLocation()
java.lang.String	getName()
Account	getOwner()
java.util.List	getParticipants() Gets the list of people that are to participate in this appointment.
java.util.Date	getStartDate()
java.lang.String	getTitle()
java.lang.String	getType() Returns the cycle type of the Appointment.
void	removeParticipant(Person person)
void	setComment(java.lang.String string)
void	setCycleEndDate(java.util.Date date)
void	setEndDate(java.util.Date end_date)
void	setLocation(java.lang.String location)
void	setName(java.lang.String name)
void	setOwner(Account account)
void	setStartDate(java.util.Date start_date)
void	setTitle(java.lang.String title)
void	setType(java.lang.String type) Sets the cycle type of the Appointment.

Methods inherited from class org.opengroupware.jogi.connect.xmlrpc.XmlRpcBaseDocument

fireNotify, getContent, getString, put, setContent

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

APPOINTMENT_OWNER

public static final java.lang.String APPOINTMENT_OWNER

See Also:

Constant Field Values

APPOINTMENT_OWNER_ID

public static final java.lang.String APPOINTMENT_OWNER_ID

See Also:

Constant Field Values

APPOINTMENT_OWNER_LOGIN

public static final java.lang.String APPOINTMENT_OWNER_LOGIN

See Also:

Constant Field Values

APPOINTMENT_START_DATE

public static final java.lang.String APPOINTMENT_START_DATE

See Also:

Constant Field Values

APPOINTMENT_END_DATE

public static final java.lang.String APPOINTMENT_END_DATE

See Also:

Constant Field Values

APPOINTMENT_NAME

public static final java.lang.String APPOINTMENT_NAME

See Also:

Constant Field Values

APPOINTMENT_COMMENT

public static final java.lang.String APPOINTMENT_COMMENT

See Also:

Constant Field Values

APPOINTMENT_ID

public static final java.lang.String APPOINTMENT_ID

See Also:

Constant Field Values

APPOINTMENT_TITLE

public static final java.lang.String APPOINTMENT_TITLE

See Also:

Constant Field Values

APPOINTMENT_PARTICIPANTS

public static final java.lang.String APPOINTMENT_PARTICIPANTS

See Also:

Constant Field Values

APPOINTMENT_CYCLE_END_DATE

public static final java.lang.String APPOINTMENT_CYCLE_END_DATE

See Also:

Constant Field Values

APPOINTMENT_TYPE

public static final java.lang.String APPOINTMENT_TYPE

See Also:

Constant Field Values

APPOINTMENT_LOCATION

public static final java.lang.String APPOINTMENT_LOCATION

See Also:

Constant Field Values

update_key_

protected java.lang.String update_key_

openGroupware_

protected OpenGroupWare openGroupware_

xmlcaller_

protected XmlRpcCaller xmlcaller_

Constructor Detail

XmlRpcAppointment

protected XmlRpcAppointment(java.util.Date start_date,
                            java.util.Date end_date,
                            java.lang.String title,
                            OpenGroupWare ogo)
                     throws OgoException,
                            ConnectionException

Method Detail

setStartDate

public void setStartDate(java.util.Date start_date)
                  throws OgoException,
                         ConnectionException

Specified by:

setStartDate in interface Appointment

Throws:

OgoException

ConnectionException

getStartDate

public java.util.Date getStartDate()
                            throws OgoException,
                                   ConnectionException

Specified by:

getStartDate in interface Appointment

Throws:

OgoException

ConnectionException

getId

public java.lang.String getId()
                       throws OgoException,
                              ConnectionException

Specified by:

getId in interface Appointment

Overrides:

getId in class XmlRpcBaseDocument

Throws:

OgoException

ConnectionException

setEndDate

public void setEndDate(java.util.Date end_date)
                throws OgoException,
                       ConnectionException

Specified by:

setEndDate in interface Appointment

Throws:

OgoException

ConnectionException

getEndDate

public java.util.Date getEndDate()
                          throws OgoException,
                                 ConnectionException

Specified by:

getEndDate in interface Appointment

Throws:

OgoException

ConnectionException

setOwner

public void setOwner(Account account)
              throws OgoException,
                     ConnectionException

Specified by:

setOwner in interface Appointment

Throws:

OgoException

ConnectionException

getOwner

public Account getOwner()
                 throws OgoException,
                        ConnectionException

Specified by:

getOwner in interface Appointment

Throws:

OgoException

ConnectionException

addParticipant

public void addParticipant(Person person)
                    throws OgoException,
                           ConnectionException

Specified by:

addParticipant in interface Appointment

Throws:

OgoException

ConnectionException

removeParticipant

public void removeParticipant(Person person)
                       throws OgoException,
                              ConnectionException

Specified by:

removeParticipant in interface Appointment

Throws:

OgoException

ConnectionException

getParticipants

public java.util.List getParticipants()
                               throws OgoException,
                                      ConnectionException

Description copied from interface: Appointment

Gets the list of people that are to participate in this appointment.

Specified by:

getParticipants in interface Appointment

Returns:

A list of Person objects or null if no if not participants are available.

Throws:

OgoException

ConnectionException

getType

public java.lang.String getType()
                         throws OgoException,
                                ConnectionException

Description copied from interface: Appointment

Returns the cycle type of the Appointment. Refer to the OpenGroupware.org documentation for a list of the possible types.

Specified by:

getType in interface Appointment

Returns:

The type of the appointment.

Throws:

OgoException

ConnectionException

setType

public void setType(java.lang.String type)
             throws OgoException,
                    ConnectionException

Description copied from interface: Appointment

Sets the cycle type of the Appointment.

Specified by:

setType in interface Appointment

Parameters:

type - Refer to the OpenGroupware.org documentation for a list of the possible types.

Throws:

OgoException

ConnectionException

getTitle

public java.lang.String getTitle()
                          throws OgoException,
                                 ConnectionException

Specified by:

getTitle in interface Appointment

Throws:

OgoException

ConnectionException

setTitle

public void setTitle(java.lang.String title)
              throws OgoException,
                     ConnectionException

Specified by:

setTitle in interface Appointment

Throws:

OgoException

ConnectionException

getName

public java.lang.String getName()
                         throws OgoException,
                                ConnectionException

Specified by:

getName in interface Appointment

Throws:

OgoException

ConnectionException

setName

public void setName(java.lang.String name)
             throws OgoException,
                    ConnectionException

Specified by:

setName in interface Appointment

Throws:

OgoException

ConnectionException

setCycleEndDate

public void setCycleEndDate(java.util.Date date)
                     throws OgoException,
                            ConnectionException

Specified by:

setCycleEndDate in interface Appointment

Throws:

OgoException

ConnectionException

getCycleEndDate

public java.util.Date getCycleEndDate()
                               throws OgoException,
                                      ConnectionException

Specified by:

getCycleEndDate in interface Appointment

Throws:

OgoException

ConnectionException

setLocation

public void setLocation(java.lang.String location)
                 throws OgoException,
                        ConnectionException

Specified by:

setLocation in interface Appointment

Throws:

OgoException

ConnectionException

getLocation

public java.lang.String getLocation()
                             throws OgoException,
                                    ConnectionException

Specified by:

getLocation in interface Appointment

Throws:

OgoException

ConnectionException

getComment

public java.lang.String getComment()
                            throws OgoException,
                                   ConnectionException

Specified by:

getComment in interface Appointment

Throws:

OgoException

ConnectionException

setComment

public void setComment(java.lang.String string)
                throws OgoException,
                       ConnectionException

Specified by:

setComment in interface Appointment

Throws:

OgoException

ConnectionException

checkNewContent

protected boolean checkNewContent(java.util.Map new_content)

Description copied from class: XmlRpcBaseDocument

This method checks whether the provided Map contains a valid document. If essential parts are missing or are of a wrong type, this method must return false, otherwise true.

Specified by:

checkNewContent in class XmlRpcBaseDocument

Parameters:

new_content - The new content for the document.

Returns:

true if the content meets all requirements, otherwise false.