org.opengroupware.jogi.ogo
Interface Appointment

All Known Implementing Classes:
XmlRpcAppointment

public interface Appointment

This represents an OGo appointment. Any changes will result in notifications (Appointment is Observable); the AppointmentManager listens to those notifications an can update the information on the OGo server.

Author:
Andreas Rath (teddius), Werner Schuster (murphee)

Method Summary
 void addParticipant(Person person)
           
 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.
 

Method Detail

setStartDate

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

getStartDate

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

getId

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

setEndDate

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

getEndDate

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

setOwner

public void setOwner(Account account)
              throws OgoException,
                     ConnectionException
Throws:
OgoException
ConnectionException

getOwner

public Account getOwner()
                 throws OgoException,
                        ConnectionException
Throws:
OgoException
ConnectionException

addParticipant

public void addParticipant(Person person)
                    throws OgoException,
                           ConnectionException
Throws:
OgoException
ConnectionException

removeParticipant

public void removeParticipant(Person person)
                       throws OgoException,
                              ConnectionException
Throws:
OgoException
ConnectionException

getParticipants

public java.util.List getParticipants()
                               throws OgoException,
                                      ConnectionException
Gets the list of people that are to participate in this 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
Returns the cycle type of the Appointment. Refer to the OpenGroupware.org documentation for a list of the possible types.

Returns:
The type of the appointment.
Throws:
OgoException
ConnectionException

setType

public void setType(java.lang.String type)
             throws OgoException,
                    ConnectionException
Sets the cycle type of the 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
Throws:
OgoException
ConnectionException

setTitle

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

getName

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

setName

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

setCycleEndDate

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

getCycleEndDate

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

setLocation

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

getLocation

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

getComment

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

setComment

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


Copyright © 2003 ogojogi Project, All Rights Reserved.