de.bea.domingo.groupware
Class CalendarEntry

java.lang.Object
  extended by de.bea.domingo.map.BaseInstance
      extended by de.bea.domingo.groupware.CalendarEntry

public class CalendarEntry
extends BaseInstance

Calendar entry, e.g. in Notes mail databases.

Author:
Kurt Riede, Thanx to Dave Rowe for some patches

Nested Class Summary
static class CalendarEntry.Type
          Represents all possible values for the importance.
 
Constructor Summary
CalendarEntry()
          Default Constructor.
CalendarEntry(CalendarEntry copyFrom)
          Copy constructor.
 
Method Summary
 void addCategories(java.util.Collection categories)
          Adds categories to a calendar entry.
 void addCategory(java.lang.String category)
          Adds a category to a calendar entry.
 java.lang.String getAppointmentUnid()
          Returns the Appointment UNID of the calendar document.
 java.util.List getCategories()
          Returns the categories of a calendar entry.
 java.lang.String getChair()
          Returns the chair of a calendar entry.
 java.util.Calendar getEndDate()
          Returns the end date of a calendar entry.
 java.util.Calendar getEndTime()
          Returns the end time of a calendar entry.
 java.util.List getInformedInvitees()
          Returns the informed invitees of a calendar entry.
 java.lang.String getLocation()
          Returns the location of a calendar entry.
 java.util.List getOptionalInvitees()
          Returns the optional invitees of a calendar entry.
 java.util.List getRequiredInvitees()
          Returns the required invitees of a calendar entry.
 java.util.List getResources()
          Returns the resources of a calendar entry.
 java.lang.String getRoom()
           
 java.util.List getRooms()
          Returns the rooms of a calendar entry.
 java.util.Calendar getStartDate()
          Returns the start date of a calendar entry.
 java.util.List getStartDateTime()
          Returns the list of occurences for a repeating event.
 java.util.Calendar getStartTime()
          Returns the start time.
 java.lang.String getTitle()
          Returns the title of a calendar entry.
 CalendarEntry.Type getType()
          Returns the type of a calendar entry.
 boolean isSendAttachments()
          Checks if attachments should be sent.
 void setAppointmentUnid(java.lang.String appointmentUnid)
           
 void setCategories(java.util.List categories)
          Sets the categories of a calendar entry.
 void setChair(java.lang.String chair)
          Sets the chair of a calendar entry.
 void setEndDate(java.util.Calendar date)
           
 void setEndDate(int year, int month, int day)
          Sets the start date of a calendar entry.
 void setEndTime(java.util.Calendar time)
          Sets the end time of a calendar entry.
 void setEndTime(int hours, int minutes, int seconds)
          Sets the end time of a calendar entry.
 void setInformedInvitees(java.util.List informedInvitees)
          Sets the informed invitees of a calendar entry.
 void setLocation(java.lang.String location)
          Sets the location a calendar entry.
 void setOptionalInvitees(java.util.List optionalInvitees)
          Sets the optional invitees of a calendar entry.
 void setRequiredInvitees(java.util.List requiredInvitees)
          Sets the required invitees of a calendar entry.
 void setResources(java.util.List resources)
          Sets the resources of a calendar entry.
 void setRoom(java.lang.String room)
           
 void setRooms(java.util.List rooms)
          Sets the rooms of a calendar entry.
 void setSendAttachments(boolean sendAttachments)
          Sets if attachments should be sent.
 void setStartDate(java.util.Calendar date)
          Sets the start date of a calendar entry.
 void setStartDate(int year, int month, int day)
          Sets the start date of a calendar entry.
 void setStartDateTime(java.util.List startDateTime)
          Set list of occurences for repeating event.
 void setStartTime(java.util.Calendar time)
          Sets the start time.
 void setStartTime(int hours, int minutes, int seconds)
          Sets the start time.
 void setTitle(java.lang.String title)
          Sets the title.
 void setType(CalendarEntry.Type type)
          Sets the type of a calendar entry.
 java.lang.String toString()
           
 
Methods inherited from class de.bea.domingo.map.BaseInstance
getUnid, setUnid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CalendarEntry

public CalendarEntry()
Default Constructor.


CalendarEntry

public CalendarEntry(CalendarEntry copyFrom)
Copy constructor.

Parameters:
copyFrom - CalendarEntry to copy from.
Method Detail

getEndDate

public final java.util.Calendar getEndDate()
Returns the end date of a calendar entry.

Returns:
Returns the endDate.

setEndDate

public final void setEndDate(java.util.Calendar date)
Parameters:
date - The endDate to set.

setEndDate

public final void setEndDate(int year,
                             int month,
                             int day)
Sets the start date of a calendar entry.

The first month of the year is JANUARY which is 0; the last month is DEDCEMBER which is 11.

Parameters:
year - the year of the endDate to set.
month - the month of the endDate to set.
day - the day of the endDate to set.

getEndTime

public final java.util.Calendar getEndTime()
Returns the end time of a calendar entry.

Returns:
Returns the endTime.

setEndTime

public final void setEndTime(java.util.Calendar time)
Sets the end time of a calendar entry.

Parameters:
time - The endTime to set.

setEndTime

public final void setEndTime(int hours,
                             int minutes,
                             int seconds)
Sets the end time of a calendar entry.

Parameters:
hours - the hours of the endDate to set.
minutes - the minutes of the endDate to set.
seconds - the seconds of the endDate to set.

getStartDate

public final java.util.Calendar getStartDate()
Returns the start date of a calendar entry.

Returns:
Returns the startDate.

setStartDate

public final void setStartDate(java.util.Calendar date)
Sets the start date of a calendar entry.

Parameters:
date - The startDate to set.

setStartDate

public final void setStartDate(int year,
                               int month,
                               int day)
Sets the start date of a calendar entry.

The first month of the year is JANUARY which is 0; the last month is DEDCEMBER which is 11.

Parameters:
year - the year of the endDate to set.
month - the month of the endDate to set.
day - the day of the endDate to set.

getStartTime

public final java.util.Calendar getStartTime()
Returns the start time.

Returns:
Returns the startTime.

setStartTime

public final void setStartTime(java.util.Calendar time)
Sets the start time.

Parameters:
time - The startTime to set.

setStartTime

public final void setStartTime(int hours,
                               int minutes,
                               int seconds)
Sets the start time.

Parameters:
hours - the hours of the endDate to set.
minutes - the minutes of the endDate to set.
seconds - the seconds of the endDate to set.

setTitle

public final void setTitle(java.lang.String title)
Sets the title.

Parameters:
title - the title

getChair

public final java.lang.String getChair()
Returns the chair of a calendar entry.

Returns:
chair the chair

setChair

public final void setChair(java.lang.String chair)
Sets the chair of a calendar entry.

Parameters:
chair - the chair

getInformedInvitees

public final java.util.List getInformedInvitees()
Returns the informed invitees of a calendar entry.

Returns:
chair the informed invitees

setInformedInvitees

public final void setInformedInvitees(java.util.List informedInvitees)
Sets the informed invitees of a calendar entry.

Parameters:
informedInvitees - the informed invitees

getLocation

public final java.lang.String getLocation()
Returns the location of a calendar entry.

Returns:
chair the location

setLocation

public final void setLocation(java.lang.String location)
Sets the location a calendar entry.

Parameters:
location - the location

getOptionalInvitees

public final java.util.List getOptionalInvitees()
Returns the optional invitees of a calendar entry.

Returns:
chair the optional invitees

setOptionalInvitees

public final void setOptionalInvitees(java.util.List optionalInvitees)
Sets the optional invitees of a calendar entry.

Parameters:
optionalInvitees - the optional invitees

getRequiredInvitees

public final java.util.List getRequiredInvitees()
Returns the required invitees of a calendar entry.

Returns:
chair the required invitees

setRequiredInvitees

public final void setRequiredInvitees(java.util.List requiredInvitees)
Sets the required invitees of a calendar entry.

Parameters:
requiredInvitees - the required invitees

getResources

public final java.util.List getResources()
Returns the resources of a calendar entry.

Returns:
chair the resources

setResources

public final void setResources(java.util.List resources)
Sets the resources of a calendar entry.

Parameters:
resources - the resources

getRooms

public final java.util.List getRooms()
Returns the rooms of a calendar entry.

Returns:
chair the rooms

setRooms

public final void setRooms(java.util.List rooms)
Sets the rooms of a calendar entry.

Parameters:
rooms - the rooms

getRoom

public final java.lang.String getRoom()
Returns:
room

setRoom

public final void setRoom(java.lang.String room)
Parameters:
room - room to set.

isSendAttachments

public final boolean isSendAttachments()
Checks if attachments should be sent.

Returns:
true if attachments should be sent else false

setSendAttachments

public final void setSendAttachments(boolean sendAttachments)
Sets if attachments should be sent.

Parameters:
sendAttachments - true if attachments should be sent else false

getType

public final CalendarEntry.Type getType()
Returns the type of a calendar entry.

Returns:
type of calendar entry

setType

public final void setType(CalendarEntry.Type type)
Sets the type of a calendar entry.

Parameters:
type - of type

getTitle

public final java.lang.String getTitle()
Returns the title of a calendar entry.

Returns:
title of calendar entry

getCategories

public final java.util.List getCategories()
Returns the categories of a calendar entry.

Returns:
list of categories of calendar entry

addCategory

public final void addCategory(java.lang.String category)
Adds a category to a calendar entry.

Parameters:
category - the category

addCategories

public final void addCategories(java.util.Collection categories)
Adds categories to a calendar entry.

Parameters:
categories - the categories

setCategories

public final void setCategories(java.util.List categories)
Sets the categories of a calendar entry.

Parameters:
categories - the categories

getStartDateTime

public final java.util.List getStartDateTime()
Returns the list of occurences for a repeating event.

Returns:
list of start/end times for a repeating event.

setStartDateTime

public final void setStartDateTime(java.util.List startDateTime)
Set list of occurences for repeating event.

Parameters:
startDateTime - list of occurences.

getAppointmentUnid

public final java.lang.String getAppointmentUnid()
Returns the Appointment UNID of the calendar document.

Returns:
Appointment UNID

setAppointmentUnid

public final void setAppointmentUnid(java.lang.String appointmentUnid)
Parameters:
appointmentUnid - the appointmentUnid to set

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object.
See Also:
Object.toString()


Domingo Java-API