com.openexchange.api
Class OXCalendar

java.lang.Object
  extended bycom.openexchange.api.OXObject
      extended bycom.openexchange.api.OXSqlObject
          extended bycom.openexchange.api.OXCommon
              extended bycom.openexchange.api.OXCalendar
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
OXAppointment, OXTask

public abstract class OXCalendar
extends OXCommon

OXAppointment

Author:
Sebastian Kauss

Field Summary
static int ACCEPT
           
static java.lang.String ALARM
           
static int APRIL
           
static int AUGUST
           
static int DAILY
           
static int DAY
           
static java.lang.String DAY_IN_MONTH
           
static java.lang.String DAYS
           
static int DECEMBER
           
static int DECLINE
           
static java.lang.String END_DATE
           
static int FEBRUARY
           
static int FRIDAY
           
static java.lang.String INTERVAL
           
static int JANUARY
           
static int JULY
           
static int JUNE
           
static int MARCH
           
static int MAY
           
static int MONDAY
           
static java.lang.String MONTH
           
static int MONTHLY
           
static int NONE
           
static java.lang.String NOTE
           
static java.lang.String NOTIFICATION
           
static int NOVEMBER
           
static int OCTOBER
           
static java.lang.String PARTICIPANTS
           
static java.lang.String PRIVATE
           
static java.lang.String RECURRENCE_DATE_POSITION
           
static java.lang.String RECURRENCE_ID
           
static java.lang.String RECURRENCE_POSITION
           
static java.lang.String RECURRENCE_TYPE
           
static int SATURDAY
           
static int SEPTEMBER
           
static java.lang.String START_DATE
           
static int SUNDAY
           
static int THURSDAY
           
static java.lang.String TITLE
           
static int TUESDAY
           
static java.lang.String UNTIL
           
static int WEDNESDAY
           
static int WEEK_DAY
           
static int WEEKEND_DAY
           
static int WEEKLY
           
static int YEARLY
           
 
Fields inherited from class com.openexchange.api.OXCommon
ATTACHMENT_FLAG, CATEGORIES, CREATED_BY, FOLDER_ID, MODIFIED_BY, PERSONAL_FOLDER_ID
 
Fields inherited from class com.openexchange.api.OXSqlObject
DELETED, NEW_AND_MODIFIED
 
Fields inherited from class com.openexchange.api.OXObject
CREATION_TIME, LAST_MODIFIED, OBJECT_ID
 
Constructor Summary
OXCalendar()
           
 
Method Summary
 void addParticipantGroup(java.lang.String name)
          add participant group
 void addParticipantUser(java.lang.String name)
          add participant
 void addParticipantUser(java.lang.String name, int confirm)
          add participant with confirmation
 java.lang.Object clone()
           
 int getAlarm()
          return the alarm in minutes before the appointments starts or 0 if no alarm was set
 java.util.Date getEnd()
          return the end of the Appointment
 int getInterval()
          return the interval of the recurrence
 java.lang.String getNote()
          return the note
 int getParticipantConfirm(java.lang.String name)
          return the confirmation status of the user
 java.util.Iterator getParticipantGroups()
          return the participanting groups
 java.util.Iterator getParticipantUsers()
          return the participanting users
 int getRecurrenceDayInMonth()
          return the day in month of the recurrence
 int getRecurrenceDays()
          return the day(s) of the recurrence
 int getRecurrenceID()
          return recurrence_id
 int getRecurrenceMonth()
          return the month of the recurrence (JANUARY - DECEMBER)
 int getRecurrencePosition()
          return the recurrence position
 int getRecurrenceType()
          return recurence_type (DAILY, WEEKLY, MONTHLY, YEARLY)
 java.util.Date getStart()
          return the begin of the Appointment
 java.lang.String getTitle()
          return the title
 java.util.Date getUntil()
          return the end of the recurrence
 boolean isPrivate()
          return private status
 void removeParticipantGroup(java.lang.String name)
          remove participant group
 void removeParticipantUser(java.lang.String name)
          remove participant user
 void setAlarm(int alarm)
          set the alarm
 void setDailyRecurrence(int interval)
          add a daily recurrence with the give interval
 void setDailyRecurrence(int interval, java.util.Date until)
          add a daily recurrence with the give interval until the given date
 void setEnd(java.util.Date enddate)
          set the end date
 void setInterval(int interval)
          set the interval of the recurrence
 void setMonthlyRecurrence(int interval, int day_in_month)
          add a monthly recurrence with the give interval and the given day in month
 void setMonthlyRecurrence(int interval, int day_in_month, java.util.Date until)
          add a monthly recurrence with the give interval and the given day in month until the given date
 void setMonthlyRecurrence(int interval, int days, int day_in_month)
          add a monthly recurrence with the give interval, the given days and the given day in month
 void setMonthlyRecurrence(int interval, int days, int day_in_month, java.util.Date until)
          add a monthly recurrence with the give interval, the given days and the given day in month until the given date
 void setNote(java.lang.String note)
          set the note
 void setNotification(boolean enable)
          enable user notification
 void setRecurrenceDay(int days)
          set recurrence days
 void setRecurrenceMonth(int month)
          set recurrence month
 void setRecurrenceMonthDay(int day_in_month)
          set recurrence day in month
 void setRecurrenceType(int type)
          set recurrence type
 void setStart(java.util.Date startdate)
          set the start date
 void setTitle(java.lang.String title)
          set the title
 void setUntil(java.util.Date until)
          set until
 void setWeeklyRecurrence(int interval, int days)
          add a weekly recurrence with the give interval and the given days
 void setWeeklyRecurrence(int interval, int days, java.util.Date until)
          add a weekly recurrence with the give interval and the given days until the given date
 void setYearlyRecurrence(int interval, int day_in_month, int month)
          add a yearly recurrence with the give interval, the given day in month and the given month
 void setYearlyRecurrence(int interval, int day_in_month, int month, java.util.Date until)
          add a yearly recurrence with the give interval, the given day in month and the given month until the given date
 void setYearlyRecurrence(int interval, int days, int day_in_month, int month)
          add a yearly recurrence with the give interval, days, day in month and month
 void setYearlyRecurrence(int interval, int days, int day_in_month, int month, java.util.Date until)
          add a yearly recurrence with the give interval, days, day in month and month until the given date
 
Methods inherited from class com.openexchange.api.OXCommon
delete, delete, getCreatedBy, getDoublicateID, getFolderID, getModifiedBy, hasAttachments, load, setDeleteQuery, setFolderID, setReturnnames, setSimpleQuery, setSimpleQuery
 
Methods inherited from class com.openexchange.api.OXSqlObject
canDelete, canRead, canWrite, destroy, getNext, getSearchQuery, getSQL_ORDER, getSQL_SELECT, getSQL_WHERE, getSQL, insert, load, load, reset, save, setSQL_ORDER, setSQL_WHERE, setSQL
 
Methods inherited from class com.openexchange.api.OXObject
contains, delete, get, getConnection, getCreationTime, getInternalFieldname, getLastModified, getMandatoryFields, getMappedField, getObjectID, getPassword, getReadableFields, getUser, getWriteableFields, isNull, iterator, put, remove, set, setInternalObject, setObjectID, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

START_DATE

public static final java.lang.String START_DATE
See Also:
Constant Field Values

END_DATE

public static final java.lang.String END_DATE
See Also:
Constant Field Values

TITLE

public static final java.lang.String TITLE
See Also:
Constant Field Values

NOTE

public static final java.lang.String NOTE
See Also:
Constant Field Values

RECURRENCE_ID

public static final java.lang.String RECURRENCE_ID
See Also:
Constant Field Values

RECURRENCE_POSITION

public static final java.lang.String RECURRENCE_POSITION
See Also:
Constant Field Values

RECURRENCE_DATE_POSITION

public static final java.lang.String RECURRENCE_DATE_POSITION
See Also:
Constant Field Values

RECURRENCE_TYPE

public static final java.lang.String RECURRENCE_TYPE
See Also:
Constant Field Values

DAY_IN_MONTH

public static final java.lang.String DAY_IN_MONTH
See Also:
Constant Field Values

DAYS

public static final java.lang.String DAYS
See Also:
Constant Field Values

MONTH

public static final java.lang.String MONTH
See Also:
Constant Field Values

INTERVAL

public static final java.lang.String INTERVAL
See Also:
Constant Field Values

UNTIL

public static final java.lang.String UNTIL
See Also:
Constant Field Values

PARTICIPANTS

public static final java.lang.String PARTICIPANTS
See Also:
Constant Field Values

NOTIFICATION

public static final java.lang.String NOTIFICATION
See Also:
Constant Field Values

ALARM

public static final java.lang.String ALARM
See Also:
Constant Field Values

PRIVATE

public static final java.lang.String PRIVATE
See Also:
Constant Field Values

ACCEPT

public static final int ACCEPT
See Also:
Constant Field Values

DECLINE

public static final int DECLINE
See Also:
Constant Field Values

NONE

public static final int NONE
See Also:
Constant Field Values

DAILY

public static final int DAILY
See Also:
Constant Field Values

WEEKLY

public static final int WEEKLY
See Also:
Constant Field Values

MONTHLY

public static final int MONTHLY
See Also:
Constant Field Values

YEARLY

public static final int YEARLY
See Also:
Constant Field Values

JANUARY

public static final int JANUARY
See Also:
Constant Field Values

FEBRUARY

public static final int FEBRUARY
See Also:
Constant Field Values

MARCH

public static final int MARCH
See Also:
Constant Field Values

APRIL

public static final int APRIL
See Also:
Constant Field Values

MAY

public static final int MAY
See Also:
Constant Field Values

JUNE

public static final int JUNE
See Also:
Constant Field Values

JULY

public static final int JULY
See Also:
Constant Field Values

AUGUST

public static final int AUGUST
See Also:
Constant Field Values

SEPTEMBER

public static final int SEPTEMBER
See Also:
Constant Field Values

OCTOBER

public static final int OCTOBER
See Also:
Constant Field Values

NOVEMBER

public static final int NOVEMBER
See Also:
Constant Field Values

DECEMBER

public static final int DECEMBER
See Also:
Constant Field Values

SUNDAY

public static final int SUNDAY
See Also:
Constant Field Values

MONDAY

public static final int MONDAY
See Also:
Constant Field Values

TUESDAY

public static final int TUESDAY
See Also:
Constant Field Values

WEDNESDAY

public static final int WEDNESDAY
See Also:
Constant Field Values

THURSDAY

public static final int THURSDAY
See Also:
Constant Field Values

FRIDAY

public static final int FRIDAY
See Also:
Constant Field Values

SATURDAY

public static final int SATURDAY
See Also:
Constant Field Values

DAY

public static final int DAY
See Also:
Constant Field Values

WEEK_DAY

public static final int WEEK_DAY
See Also:
Constant Field Values

WEEKEND_DAY

public static final int WEEKEND_DAY
See Also:
Constant Field Values
Constructor Detail

OXCalendar

public OXCalendar()
Method Detail

getAlarm

public int getAlarm()
return the alarm in minutes before the appointments starts or 0 if no alarm was set

Returns:
alarm

setAlarm

public void setAlarm(int alarm)
set the alarm

Parameters:
alarm -

getStart

public java.util.Date getStart()
return the begin of the Appointment

Returns:
begin

setStart

public void setStart(java.util.Date startdate)
set the start date

Parameters:
startdate -

getEnd

public java.util.Date getEnd()
return the end of the Appointment

Returns:
end

setEnd

public void setEnd(java.util.Date enddate)
set the end date

Parameters:
enddate -

getTitle

public java.lang.String getTitle()
return the title

Returns:
title

setTitle

public void setTitle(java.lang.String title)
set the title

Parameters:
title -

getNote

public java.lang.String getNote()
return the note

Returns:
note

setNote

public void setNote(java.lang.String note)
set the note

Parameters:
note -

isPrivate

public boolean isPrivate()
return private status

Returns:
private

getRecurrenceID

public int getRecurrenceID()
return recurrence_id

Returns:
recurence_id

getRecurrenceType

public int getRecurrenceType()
return recurence_type (DAILY, WEEKLY, MONTHLY, YEARLY)

Returns:
recurence_type (DAILY, WEEKLY, MONTHLY, YEARLY)

getInterval

public int getInterval()
return the interval of the recurrence

Returns:
recurrence

getRecurrenceDayInMonth

public int getRecurrenceDayInMonth()
return the day in month of the recurrence

Returns:
int day_in_month

getRecurrenceMonth

public int getRecurrenceMonth()
return the month of the recurrence (JANUARY - DECEMBER)

Returns:
int month (JANUARY - DECEMBER)

getRecurrenceDays

public int getRecurrenceDays()
return the day(s) of the recurrence

Returns:
int days

getRecurrencePosition

public int getRecurrencePosition()
return the recurrence position

Returns:
recurrence position

getUntil

public java.util.Date getUntil()
return the end of the recurrence

Returns:
until

addParticipantUser

public void addParticipantUser(java.lang.String name)
add participant

Parameters:
name -

addParticipantUser

public void addParticipantUser(java.lang.String name,
                               int confirm)
add participant with confirmation

Parameters:
name -
confirm -

addParticipantGroup

public void addParticipantGroup(java.lang.String name)
add participant group

Parameters:
name -

removeParticipantUser

public void removeParticipantUser(java.lang.String name)
remove participant user

Parameters:
name -

removeParticipantGroup

public void removeParticipantGroup(java.lang.String name)
remove participant group

Parameters:
name -

setInterval

public void setInterval(int interval)
set the interval of the recurrence

Parameters:
interval -

setRecurrenceDay

public void setRecurrenceDay(int days)
set recurrence days

Parameters:
days -

setRecurrenceMonthDay

public void setRecurrenceMonthDay(int day_in_month)
set recurrence day in month

Parameters:
day_in_month -

setRecurrenceMonth

public void setRecurrenceMonth(int month)
set recurrence month

Parameters:
month -

setRecurrenceType

public void setRecurrenceType(int type)
set recurrence type

Parameters:
type -

setUntil

public void setUntil(java.util.Date until)
set until

Parameters:
until -

setDailyRecurrence

public void setDailyRecurrence(int interval)
add a daily recurrence with the give interval

Parameters:
interval -

setDailyRecurrence

public void setDailyRecurrence(int interval,
                               java.util.Date until)
add a daily recurrence with the give interval until the given date

Parameters:
interval -
until -

setWeeklyRecurrence

public void setWeeklyRecurrence(int interval,
                                int days)
add a weekly recurrence with the give interval and the given days

Parameters:
interval -
days -

setWeeklyRecurrence

public void setWeeklyRecurrence(int interval,
                                int days,
                                java.util.Date until)
add a weekly recurrence with the give interval and the given days until the given date

Parameters:
interval -
days -
until -

setMonthlyRecurrence

public void setMonthlyRecurrence(int interval,
                                 int day_in_month)
add a monthly recurrence with the give interval and the given day in month

Parameters:
interval -
day_in_month -

setMonthlyRecurrence

public void setMonthlyRecurrence(int interval,
                                 int day_in_month,
                                 java.util.Date until)
add a monthly recurrence with the give interval and the given day in month until the given date

Parameters:
interval -
day_in_month -
until -

setMonthlyRecurrence

public void setMonthlyRecurrence(int interval,
                                 int days,
                                 int day_in_month)
add a monthly recurrence with the give interval, the given days and the given day in month

Parameters:
interval -
days -
day_in_month -

setMonthlyRecurrence

public void setMonthlyRecurrence(int interval,
                                 int days,
                                 int day_in_month,
                                 java.util.Date until)
add a monthly recurrence with the give interval, the given days and the given day in month until the given date

Parameters:
interval -
days -
day_in_month -
until -

setYearlyRecurrence

public void setYearlyRecurrence(int interval,
                                int day_in_month,
                                int month)
add a yearly recurrence with the give interval, the given day in month and the given month

Parameters:
interval -
day_in_month -
month -

setYearlyRecurrence

public void setYearlyRecurrence(int interval,
                                int day_in_month,
                                int month,
                                java.util.Date until)
add a yearly recurrence with the give interval, the given day in month and the given month until the given date

Parameters:
interval -
day_in_month -
month -
until -

setYearlyRecurrence

public void setYearlyRecurrence(int interval,
                                int days,
                                int day_in_month,
                                int month)
add a yearly recurrence with the give interval, days, day in month and month

Parameters:
interval -
days -
day_in_month -
month -

setYearlyRecurrence

public void setYearlyRecurrence(int interval,
                                int days,
                                int day_in_month,
                                int month,
                                java.util.Date until)
add a yearly recurrence with the give interval, days, day in month and month until the given date

Parameters:
interval -
days -
day_in_month -
month -
until -

getParticipantUsers

public java.util.Iterator getParticipantUsers()
return the participanting users

Returns:
users

getParticipantGroups

public java.util.Iterator getParticipantGroups()
return the participanting groups

Returns:
groups

getParticipantConfirm

public int getParticipantConfirm(java.lang.String name)
return the confirmation status of the user

Parameters:
name -
Returns:
confirm

setNotification

public void setNotification(boolean enable)
enable user notification

Parameters:
enable -

clone

public java.lang.Object clone()
Overrides:
clone in class OXCommon