org.jasig.schedassist
Interface ICalendarDataDao

public interface ICalendarDataDao

Interface for interacting with the back end calendar system.

Version:

$Id: CalendarDao.java 2509 2010-09-08 15:44:30Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

void	cancelAppointment(IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent event) Cancel the specified appointment in the IScheduleOwner's schedule.
void	checkForConflicts(IScheduleOwner owner, AvailableBlock block) Check the IScheduleOwner's schedule for events within the times defined by the AvailableBlock.
net.fortuna.ical4j.model.component.VEvent	createAppointment(IScheduleVisitor visitor, IScheduleOwner owner, AvailableBlock block, String eventDescription) Create an appointment.
net.fortuna.ical4j.model.Calendar	getCalendar(ICalendarAccount calendarAccount, Date startDate, Date endDate) Retrieve the Calendar for the ICalendarAccount between the specified dates.
net.fortuna.ical4j.model.component.VEvent	getExistingAppointment(IScheduleOwner owner, AvailableBlock block) Lookup the VEvent that corresponds with the information in the AvailableBlock in the IScheduleOwner's schedule.
net.fortuna.ical4j.model.component.VEvent	joinAppointment(IScheduleVisitor visitor, IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent appointment) Add the specified IScheduleVisitor as an attendee to the VEvent in the IScheduleOwner's schedule.
net.fortuna.ical4j.model.component.VEvent	leaveAppointment(IScheduleVisitor visitor, IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent appointment) Remove the specified IScheduleVisitor from the attendees in the VEvent in the IScheduleOwner's schedule.
void	purgeAvailableScheduleReflections(IScheduleOwner owner, Date startDate, Date endDate) Purge any available schedule reflections from the specified IScheduleOwner's account between the specified dates.
void	reflectAvailableSchedule(IScheduleOwner owner, AvailableSchedule schedule) The purpose of this method is to reflect a copy of the IScheduleOwner's current AvailableSchedule in the owner's calendar account.

Method Detail

getCalendar

net.fortuna.ical4j.model.Calendar getCalendar(ICalendarAccount calendarAccount,
                                              Date startDate,
                                              Date endDate)

Retrieve the Calendar for the ICalendarAccount between the specified dates.

Parameters:

calendarAccount -

startDate -

endDate -

Returns:

the corresponding Calendar data

getExistingAppointment

net.fortuna.ical4j.model.component.VEvent getExistingAppointment(IScheduleOwner owner,
                                                                 AvailableBlock block)

Lookup the VEvent that corresponds with the information in the AvailableBlock in the IScheduleOwner's schedule. Will only return Scheduling Assistant appointments (e.g. events created with this software); if no VEvent is stored in the owner's schedule this method returns null.

Parameters:

owner -

block -

Returns:

the existing scheduling asssitant appointment, or null if none found

createAppointment

net.fortuna.ical4j.model.component.VEvent createAppointment(IScheduleVisitor visitor,
                                                            IScheduleOwner owner,
                                                            AvailableBlock block,
                                                            String eventDescription)

Create an appointment. The IScheduleOwner must be the "owner" of the appointment. The IScheduleVisitor must be invited to the appointment, and should automatically accept the invitation.

Parameters:

visitor -

owner -

block - the target AvailableBlock

eventDescription - text that should be added to the DESCRIPTION property of the event

Returns:

the newly created event

cancelAppointment

void cancelAppointment(IScheduleOwner owner,
                       net.fortuna.ical4j.model.component.VEvent event)

Cancel the specified appointment in the IScheduleOwner's schedule.

Parameters:

owner -

event -

joinAppointment

net.fortuna.ical4j.model.component.VEvent joinAppointment(IScheduleVisitor visitor,
                                                          IScheduleOwner owner,
                                                          net.fortuna.ical4j.model.component.VEvent appointment)
                                                          throws SchedulingException

Add the specified IScheduleVisitor as an attendee to the VEvent in the IScheduleOwner's schedule.

Parameters:

visitor -

owner -

appointment -

Returns:

the appointment

Throws:

SchedulingException

leaveAppointment

net.fortuna.ical4j.model.component.VEvent leaveAppointment(IScheduleVisitor visitor,
                                                           IScheduleOwner owner,
                                                           net.fortuna.ical4j.model.component.VEvent appointment)
                                                           throws SchedulingException

Remove the specified IScheduleVisitor from the attendees in the VEvent in the IScheduleOwner's schedule.

Parameters:

visitor -

owner -

appointment -

Returns:

the appointment

Throws:

SchedulingException

checkForConflicts

void checkForConflicts(IScheduleOwner owner,
                       AvailableBlock block)
                       throws ConflictExistsException

Check the IScheduleOwner's schedule for events within the times defined by the AvailableBlock. If a conflict exists, throw the ConflictExistsException.

Parameters:

owner -

block -

Throws:

ConflictExistsException

reflectAvailableSchedule

void reflectAvailableSchedule(IScheduleOwner owner,
                              AvailableSchedule schedule)

The purpose of this method is to reflect a copy of the IScheduleOwner's current AvailableSchedule in the owner's calendar account. If the implementation takes any action on invocation, it SHOULD replace any records found for days listed in the schedule argument.

Parameters:

owner -

schedule -

purgeAvailableScheduleReflections

void purgeAvailableScheduleReflections(IScheduleOwner owner,
                                       Date startDate,
                                       Date endDate)

Purge any available schedule reflections from the specified IScheduleOwner's account between the specified dates.

Parameters:

owner -

startDate -

endDate -