org.jasig.schedassist.model
Interface IVisibleScheduleBuilder

All Known Implementing Classes:

VisibleScheduleBuilder

public interface IVisibleScheduleBuilder

Interface defining operations for calculating VisibleSchedules.

Version:

$Id: IVisibleScheduleBuilder.java 2326 2010-07-30 21:20:14Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

VisibleSchedule	calculateVisibleSchedule(Date startTime, Date endTime, net.fortuna.ical4j.model.Calendar calendar, AvailableSchedule schedule, IScheduleOwner owner) This method should simply delegate to calculateVisibleSchedule(Date, Date, Calendar, AvailableSchedule, IScheduleOwner, IScheduleVisitor), passing null in for the IScheduleVisitor argument.
VisibleSchedule	calculateVisibleSchedule(Date startTime, Date endTime, net.fortuna.ical4j.model.Calendar calendar, AvailableSchedule schedule, IScheduleOwner owner, IScheduleVisitor visitor) Core algorithm for calculating a VisibleSchedule for an IScheduleVisitor viewing an IScheduleOwner's account.
VisibleSchedule	calculateVisitorConflicts(Date startTime, Date endTime, net.fortuna.ical4j.model.Calendar calendar, AvailableSchedule schedule, MeetingDurations meetingDurations, IScheduleVisitor visitor) This method is intended to provide a means for incorporating the IScheduleVisitor's own calendar data within the display of an IScheduleOwners schedule.

Method Detail

calculateVisibleSchedule

VisibleSchedule calculateVisibleSchedule(Date startTime,
                                         Date endTime,
                                         net.fortuna.ical4j.model.Calendar calendar,
                                         AvailableSchedule schedule,
                                         IScheduleOwner owner)

This method should simply delegate to calculateVisibleSchedule(Date, Date, Calendar, AvailableSchedule, IScheduleOwner, IScheduleVisitor), passing null in for the IScheduleVisitor argument. As such, it will never return appointments with "ATTENDING" status (only FREE or BUSY).

Parameters:

startTime -

endTime -

calendar -

schedule -

owner -

Returns:

an appropriate VisibleSchedule

calculateVisibleSchedule

VisibleSchedule calculateVisibleSchedule(Date startTime,
                                         Date endTime,
                                         net.fortuna.ical4j.model.Calendar calendar,
                                         AvailableSchedule schedule,
                                         IScheduleOwner owner,
                                         IScheduleVisitor visitor)

Core algorithm for calculating a VisibleSchedule for an IScheduleVisitor viewing an IScheduleOwner's account.

Parameters:

startTime -

endTime -

calendar -

schedule -

owner -

visitor -

Returns:

an appropriate VisibleSchedule

calculateVisitorConflicts

VisibleSchedule calculateVisitorConflicts(Date startTime,
                                          Date endTime,
                                          net.fortuna.ical4j.model.Calendar calendar,
                                          AvailableSchedule schedule,
                                          MeetingDurations meetingDurations,
                                          IScheduleVisitor visitor)

This method is intended to provide a means for incorporating the IScheduleVisitor's own calendar data within the display of an IScheduleOwners schedule. The MeetingDurations argument is required and represents the preference of the IScheduleOwner in context.

Parameters:

startTime -

endTime -

calendar -

schedule -

meetingDurations -

visitor -

Returns:

an appropriate VisibleSchedule