org.bedework.calsvci

Interface SchedulingI

All Superinterfaces:

Serializable

public interface SchedulingI
extends Serializable

Author:

Mike Douglass

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SchedulingI.FbGranulatedResponse Used for user interface.
static class	SchedulingI.FbResponses

Method Summary

Modifier and Type	Method and Description
SchedulingI.FbResponses	aggregateFreeBusy(ScheduleResult sr, BwDateTime start, BwDateTime end, BwDuration granularity) Get aggregated free busy for a ScheduleResult.
ScheduleResult	attendeeRespond(EventInfo ei, int method) An attendee responds to a request.
ScheduleResult	declineCounter(EventInfo ei, String comment, BwAttendee fromAtt)
BwEvent	getFreeBusy(Collection<BwCalendar> fbset, BwPrincipal who, BwDateTime start, BwDateTime end, BwOrganizer org, String uid, String exceptUid) Get the free busy for the given principal as a list of busy periods.
Collection<BwCalendar>	getFreebusySet() Get calendar collections which affect freebusy.
EventInfo	getStoredMeeting(BwEvent ev) Return the users copy of the active meeting with the same uid as that given.
SchedulingI.FbGranulatedResponse	granulateFreeBusy(BwEvent fb, BwDateTime start, BwDateTime end, BwDuration granularity) Granulate (divide into equal chunks and return the result.
ScheduleResult	requestRefresh(EventInfo ei, String comment) Attendee wants a refresh
ScheduleResult	schedule(EventInfo ei, String recipient, String fromAttUri, boolean iSchedule) Schedule a meeting or publish an event.
ScheduleResult	scheduleResponse(EventInfo ei) Respond to a scheduling request.
ScheduleResult	sendReply(EventInfo ei, int partstat, String comment) Attendee wants to send a reply
void	setupReschedule(EventInfo ei) We have detected changes to an event that require a schedule.

Method Detail

setupReschedule

void setupReschedule(EventInfo ei)
              throws CalFacadeException

We have detected changes to an event that require a schedule. This method will set up the event ready for a call to send out the REQUEST. This will involve at least incrementing th esequence and setting PARTSTAT to NEEDS-ACTION

Parameters:

ei -

Throws:

CalFacadeException

schedule

ScheduleResult schedule(EventInfo ei,
                        String recipient,
                        String fromAttUri,
                        boolean iSchedule)
                 throws CalFacadeException

Schedule a meeting or publish an event. The event object must have the organizer and attendees and possibly recipients set according to itip + caldav.

The event will be added to the users outbox which will trigger the send of requests to other users inboxes. For users within this system the request will be immediately addded to the recipients inbox. For external users they are sent via ischedule or mail.

Parameters:

ei - EventInfo object containing event with method=REQUEST, CANCEL, ADD, DECLINECOUNTER or PUBLISH

recipient - - non null to send to this recipient only (for REFRESH)

fromAttUri -

iSchedule - true if it's an iSchedule request.

Returns:

ScheduleResult

Throws:

CalFacadeException

declineCounter

ScheduleResult declineCounter(EventInfo ei,
                              String comment,
                              BwAttendee fromAtt)
                       throws CalFacadeException

Parameters:

ei -

comment -

fromAtt -

Returns:

ScheduleResult

Throws:

CalFacadeException

requestRefresh

ScheduleResult requestRefresh(EventInfo ei,
                              String comment)
                       throws CalFacadeException

Attendee wants a refresh

Parameters:

ei - event which is probably in a calendar.

comment - - optional comment

Returns:

ScheduleResult

Throws:

CalFacadeException

sendReply

ScheduleResult sendReply(EventInfo ei,
                         int partstat,
                         String comment)
                  throws CalFacadeException

Attendee wants to send a reply

Parameters:

ei - event which is probably in a calendar.

partstat - - valid partstat.

comment - - optional comment

Returns:

ScheduleResult

Throws:

CalFacadeException

attendeeRespond

ScheduleResult attendeeRespond(EventInfo ei,
                               int method)
                        throws CalFacadeException

An attendee responds to a request.

Parameters:

ei - The stored updated copy of the meeting

method - - the scheduling method

Returns:

ScheduleResult

Throws:

CalFacadeException

scheduleResponse

ScheduleResult scheduleResponse(EventInfo ei)
                         throws CalFacadeException

Respond to a scheduling request. The event object must have the organizer and a single attendee and possibly recipient set according to itip + caldav.

The event will be added to the users outbox which will trigger the send of a request to the organizers inbox. For an organizer within this system the request will be immediately addded to the recipients inbox. For an external organizer it is sent via mail.

Parameters:

ei - EventInfo object with event with method=REPLY, COUNTER or REFRESH

Returns:

ScheduleResult

Throws:

CalFacadeException

getFreeBusy

BwEvent getFreeBusy(Collection<BwCalendar> fbset,
                    BwPrincipal who,
                    BwDateTime start,
                    BwDateTime end,
                    BwOrganizer org,
                    String uid,
                    String exceptUid)
             throws CalFacadeException

Get the free busy for the given principal as a list of busy periods.

Parameters:

fbset - Collections for which to provide free-busy. Null for the for default collection (as specified by user). Used for local access to a given calendar via e.g. caldav

who - If cal is null get the info for this user, otherwise this is used as the free/busy result owner

start -

end -

org - - needed to make the result compliant

uid - - uid of requesting component or null for no request

exceptUid - if non-null omit this uid from the freebusy calculation

Returns:

BwEvent

Throws:

CalFacadeException

getFreebusySet

Collection<BwCalendar> getFreebusySet()
                               throws CalFacadeException

Get calendar collections which affect freebusy.

Returns:

Collection of calendars.

Throws:

CalFacadeException

aggregateFreeBusy

SchedulingI.FbResponses aggregateFreeBusy(ScheduleResult sr,
                                          BwDateTime start,
                                          BwDateTime end,
                                          BwDuration granularity)
                                   throws CalFacadeException

Get aggregated free busy for a ScheduleResult.

Parameters:

sr - ScheduleResult

start -

end -

granularity -

Returns:

FbResponses

Throws:

CalFacadeException

granulateFreeBusy

SchedulingI.FbGranulatedResponse granulateFreeBusy(BwEvent fb,
                                                   BwDateTime start,
                                                   BwDateTime end,
                                                   BwDuration granularity)
                                            throws CalFacadeException

Granulate (divide into equal chunks and return the result. The response from the original request may be for a different time range than requested.

Parameters:

fb -

start - start from original request

end - end from original request

granularity -

Returns:

FbResponse

Throws:

CalFacadeException

getStoredMeeting

EventInfo getStoredMeeting(BwEvent ev)
                    throws CalFacadeException

Return the users copy of the active meeting with the same uid as that given.

Parameters:

ev -

Returns:

possibly null meeting

Throws:

CalFacadeException