Blue Mind
Release 1.0

net.bluemind.core.api.services
Interface ICalendar

All Known Implementing Classes:
AbstractEventSyncClient, CalendarClient

public interface ICalendar


Method Summary
 ImportStats batchCreate(AccessToken token, int calendarId, java.util.List<Event> event)
           
 int create(AccessToken token, Event event)
           
 CalendarInfo createCalendar(AccessToken token, CalendarInfo c)
           
 java.lang.String createICS(AccessToken token, Event event)
           
 java.lang.String createICS(AccessToken token, java.util.List<Event> events)
           
 CalendarView createView(AccessToken at, CalendarView cv)
           
 Event delete(AccessToken token, int id)
           
 Event deleteByExtId(AccessToken token, java.lang.String extId)
           
 void deleteCalendar(AccessToken token, int calendarId)
           
 void deleteView(AccessToken at, int id)
           
 EventChanges doSync(AccessToken token, java.util.List<SyncCalendar> syncCalendars, EventChanges clientChanges, java.util.Map<java.lang.String,EventPartNotification> notifications, java.util.List<EventAlert> alerts)
          Synchronize Event data between the client and the bm-core.
 EventChanges doSync(AccessToken token, java.util.Map<java.lang.Integer,java.util.Date> calendars, EventChanges clientChanges, java.util.Map<java.lang.String,EventPartNotification> notifications, java.util.List<EventAlert> alerts)
          Deprecated. 
 EventChanges doSync(AccessToken token, SyncMode mode, java.util.Map<java.lang.Integer,java.util.Date> calendars, EventChanges clientChanges, java.util.Map<java.lang.String,EventPartNotification> notifications, java.util.List<EventAlert> alerts)
          Deprecated. 
 java.lang.String exportICS(AccessToken token, java.util.Date before)
          Exports events as ICS
 java.lang.String exportResourceICS(AccessToken token, int resourceId, java.util.Date before)
          Export event as ICS from a resource calendar
 OccurrenceFactory fetchFreeBusy(AccessToken token, java.util.List<java.lang.String> attendees, java.util.Date begin, java.util.Date end)
           
 OccurrenceFactory find(AccessToken token, CalendarQuery cq)
           
 ResultList<CalendarInfo> findCalendar(AccessToken token, java.lang.String pattern, java.lang.String filter)
           
 ResultList<CalendarGroup> findFromPattern(AccessToken token, java.lang.String pattern, java.lang.String filter)
           
 User findMe(AccessToken token)
           
 ResultList<CalendarInfo> findMyCalendars(AccessToken token)
           
 java.util.List<Event> getAllEvents(AccessToken token, java.lang.String calendar, EventType eventType)
           
 java.util.List<APIKey> getApiKeys(AccessToken token)
           
 java.util.HashMap<java.lang.Integer,java.lang.Integer> getCalendarColor(AccessToken at)
           
 CalendarInfo getCalendarFromId(AccessToken token, int calendarId)
           
 Event getEventFromExtId(AccessToken token, java.lang.String extId)
           
 Event getEventFromId(AccessToken token, int id)
           
 java.util.List<FreeBusy> getFreeBusy(AccessToken token, FreeBusyRequest fb)
           
 java.util.Date getLastUpdate(AccessToken token, java.lang.String calendar)
           
 java.util.List<Event> getListEventsFromIntervalDate(AccessToken token, java.lang.String calendar, java.util.Date start, java.util.Date end)
           
 int getPendingEventCount(AccessToken token)
           
 OccurrenceFactory getReminders(AccessToken token, java.util.Date date)
           
 CalendarInfo[] getSubscription(AccessToken token, int userId)
           
 java.lang.String getUserEmail(AccessToken token)
           
 CalendarView getView(AccessToken at, int id)
           
 java.util.List<CalendarView> getViews(AccessToken at)
           
 OccurrenceFactory getWaitingEvents(AccessToken token)
           
 ImportStats importICS(AccessToken token, java.lang.String ics)
          Imports an ICS file into the logged-in user calendar
 ImportStats importICS(AccessToken token, java.lang.String ics, int calendarId)
           
 java.lang.String insertEventException(AccessToken token, int parentEventId, java.util.Date OccurrenceDate, java.util.Date date, int duration, EventExceptionKind kind, java.lang.String extId, java.lang.String title)
           
 java.lang.String insertEventExceptionByExtId(AccessToken token, java.lang.String parentEventExtId, java.util.Date OccurrenceDate, java.util.Date date, int duration, EventExceptionKind kind, java.lang.String extId, java.lang.String title)
           
 boolean isWritableCalendar(AccessToken token, java.lang.String calendar)
           
 CalendarInfo[] listCalendars(AccessToken token)
           
 java.util.List<Event> multipleCreate(AccessToken token, java.util.List<Event> events)
          Create multiple Event on bm-core.
 java.lang.String parseFreeBusyToICS(AccessToken token, FreeBusy fbr)
           
 java.util.List<Event> parseICS(AccessToken token, java.lang.String ics)
           
 FreeBusyRequest parseICSFreeBusy(AccessToken token, java.lang.String ics)
           
 void resetCalendar(AccessToken token, int calendarId)
           
 void setAlert(AccessToken token, int eventId, int userId, java.lang.Integer alert)
           
 void setCalendarColor(AccessToken at, java.lang.String entity, int entityId, java.lang.Integer eventOwner)
           
 void setParticipation(AccessToken token, java.util.List<java.lang.Integer> eventId, java.lang.String entity, int entityId, ParticipationState ps, boolean ownerNotification)
           
 void setParticipationByExtId(AccessToken token, java.util.List<java.lang.String> eventExtIds, java.lang.String entity, int entityId, ParticipationState ps, boolean ownerNotification)
           
 void setParticipationByExtIdWithNote(AccessToken token, java.util.List<java.lang.String> eventExtIds, java.lang.String entity, int entityId, ParticipationState ps, boolean ownerNotification, java.lang.String note)
           
 void setParticipationWithNote(AccessToken token, java.util.List<java.lang.Integer> eventId, java.lang.String entity, int entityId, ParticipationState ps, boolean ownerNotification, java.lang.String note)
           
 void setSubscription(AccessToken token, int userId, java.util.List<java.lang.Integer> calendarIds)
           
 APIKey share(AccessToken token, java.lang.String email, java.lang.String displayName)
           
 void subscribe(AccessToken token, int userId, java.util.List<java.lang.Integer> calendarIds)
           
 void unshare(AccessToken token, java.lang.String externalToken)
           
 void unsubscribe(AccessToken token, int userId, java.util.List<java.lang.Integer> calendarIds)
           
 Event update(AccessToken token, Event event, boolean updateAttendees)
          Updates the event ;-) Returns null if the event does not exist.
 CalendarInfo updateCalendar(AccessToken token, CalendarInfo c)
           
 

Method Detail

listCalendars

CalendarInfo[] listCalendars(AccessToken token)
                             throws ServerFault,
                                    AuthFault
Throws:
ServerFault
AuthFault

delete

Event delete(AccessToken token,
             int id)
             throws AuthFault,
                    ServerFault
Throws:
AuthFault
ServerFault

deleteByExtId

Event deleteByExtId(AccessToken token,
                    java.lang.String extId)
                    throws AuthFault,
                           ServerFault
Throws:
AuthFault
ServerFault

update

Event update(AccessToken token,
             Event event,
             boolean updateAttendees)
             throws AuthFault,
                    ServerFault
Updates the event ;-) Returns null if the event does not exist.

Parameters:
token -
event -
updateAttendees -
Returns:
Throws:
AuthFault
ServerFault

create

int create(AccessToken token,
           Event event)
           throws AuthFault,
                  ServerFault
Throws:
AuthFault
ServerFault

batchCreate

ImportStats batchCreate(AccessToken token,
                        int calendarId,
                        java.util.List<Event> event)
                        throws AuthFault,
                               ServerFault
Throws:
AuthFault
ServerFault

multipleCreate

java.util.List<Event> multipleCreate(AccessToken token,
                                     java.util.List<Event> events)
                                     throws AuthFault,
                                            ServerFault
Create multiple Event on bm-core. Warning multipleCreate(AccessToken, List):

Parameters:
token - User who is charged for the creation.
events - List of Event to be created
Returns:
List of Event successfully created on server
Throws:
AuthFault
ServerFault

getEventFromId

Event getEventFromId(AccessToken token,
                     int id)
                     throws AuthFault,
                            ServerFault
Throws:
AuthFault
ServerFault

getUserEmail

java.lang.String getUserEmail(AccessToken token)
                              throws AuthFault,
                                     ServerFault
Throws:
AuthFault
ServerFault

getEventFromExtId

Event getEventFromExtId(AccessToken token,
                        java.lang.String extId)
                        throws AuthFault,
                               ServerFault
Throws:
AuthFault
ServerFault

getListEventsFromIntervalDate

java.util.List<Event> getListEventsFromIntervalDate(AccessToken token,
                                                    java.lang.String calendar,
                                                    java.util.Date start,
                                                    java.util.Date end)
                                                    throws AuthFault,
                                                           ServerFault
Throws:
AuthFault
ServerFault

getAllEvents

java.util.List<Event> getAllEvents(AccessToken token,
                                   java.lang.String calendar,
                                   EventType eventType)
                                   throws AuthFault,
                                          ServerFault
Throws:
AuthFault
ServerFault

createICS

java.lang.String createICS(AccessToken token,
                           Event event)
                           throws ServerFault,
                                  AuthFault
Throws:
ServerFault
AuthFault

createICS

java.lang.String createICS(AccessToken token,
                           java.util.List<Event> events)
                           throws ServerFault,
                                  AuthFault
Throws:
ServerFault
AuthFault

exportICS

java.lang.String exportICS(AccessToken token,
                           java.util.Date before)
                           throws ServerFault,
                                  AuthFault
Exports events as ICS

Parameters:
token -
before - export every event before the given date. Export everything if null.
Returns:
the ICS string
Throws:
ServerFault
AuthFault

exportResourceICS

java.lang.String exportResourceICS(AccessToken token,
                                   int resourceId,
                                   java.util.Date before)
                                   throws ServerFault,
                                          AuthFault
Export event as ICS from a resource calendar

Parameters:
token -
calendarId -
object -
Throws:
ServerFault
AuthFault

importICS

ImportStats importICS(AccessToken token,
                      java.lang.String ics)
                      throws AuthFault,
                             ServerFault
Imports an ICS file into the logged-in user calendar

Parameters:
token -
Returns:
ics event count & total imported events
Throws:
AuthFault
ServerFault

importICS

ImportStats importICS(AccessToken token,
                      java.lang.String ics,
                      int calendarId)
                      throws AuthFault,
                             ServerFault
Throws:
AuthFault
ServerFault

parseICS

java.util.List<Event> parseICS(AccessToken token,
                               java.lang.String ics)
                               throws AuthFault,
                                      ServerFault
Throws:
AuthFault
ServerFault

parseICSFreeBusy

FreeBusyRequest parseICSFreeBusy(AccessToken token,
                                 java.lang.String ics)
                                 throws ServerFault,
                                        AuthFault
Throws:
ServerFault
AuthFault

getFreeBusy

java.util.List<FreeBusy> getFreeBusy(AccessToken token,
                                     FreeBusyRequest fb)
                                     throws AuthFault,
                                            ServerFault
Throws:
AuthFault
ServerFault

parseFreeBusyToICS

java.lang.String parseFreeBusyToICS(AccessToken token,
                                    FreeBusy fbr)
                                    throws ServerFault,
                                           AuthFault
Throws:
ServerFault
AuthFault

getLastUpdate

java.util.Date getLastUpdate(AccessToken token,
                             java.lang.String calendar)
                             throws ServerFault,
                                    AuthFault
Throws:
ServerFault
AuthFault

isWritableCalendar

boolean isWritableCalendar(AccessToken token,
                           java.lang.String calendar)
                           throws ServerFault,
                                  AuthFault
Throws:
ServerFault
AuthFault

deleteView

void deleteView(AccessToken at,
                int id)
                throws ServerFault,
                       AuthFault
Throws:
ServerFault
AuthFault

getView

CalendarView getView(AccessToken at,
                     int id)
                     throws ServerFault,
                            AuthFault
Throws:
ServerFault
AuthFault

getViews

java.util.List<CalendarView> getViews(AccessToken at)
                                      throws ServerFault,
                                             AuthFault
Throws:
ServerFault
AuthFault

createView

CalendarView createView(AccessToken at,
                        CalendarView cv)
                        throws ServerFault,
                               AuthFault
Throws:
ServerFault
AuthFault

getCalendarColor

java.util.HashMap<java.lang.Integer,java.lang.Integer> getCalendarColor(AccessToken at)
                                                                        throws ServerFault,
                                                                               AuthFault
Throws:
ServerFault
AuthFault

setCalendarColor

void setCalendarColor(AccessToken at,
                      java.lang.String entity,
                      int entityId,
                      java.lang.Integer eventOwner)
                      throws ServerFault,
                             AuthFault
Throws:
ServerFault
AuthFault

getWaitingEvents

OccurrenceFactory getWaitingEvents(AccessToken token)
                                   throws AuthFault,
                                          ServerFault
Throws:
AuthFault
ServerFault

find

OccurrenceFactory find(AccessToken token,
                       CalendarQuery cq)
                       throws AuthFault,
                              ServerFault
Throws:
AuthFault
ServerFault

share

APIKey share(AccessToken token,
             java.lang.String email,
             java.lang.String displayName)
             throws AuthFault,
                    ServerFault
Throws:
AuthFault
ServerFault

unshare

void unshare(AccessToken token,
             java.lang.String externalToken)
             throws AuthFault,
                    ServerFault
Throws:
AuthFault
ServerFault

getApiKeys

java.util.List<APIKey> getApiKeys(AccessToken token)
                                  throws AuthFault,
                                         ServerFault
Throws:
AuthFault
ServerFault

fetchFreeBusy

OccurrenceFactory fetchFreeBusy(AccessToken token,
                                java.util.List<java.lang.String> attendees,
                                java.util.Date begin,
                                java.util.Date end)
                                throws AuthFault,
                                       ServerFault
Throws:
AuthFault
ServerFault

insertEventException

java.lang.String insertEventException(AccessToken token,
                                      int parentEventId,
                                      java.util.Date OccurrenceDate,
                                      java.util.Date date,
                                      int duration,
                                      EventExceptionKind kind,
                                      java.lang.String extId,
                                      java.lang.String title)
                                      throws AuthFault,
                                             ServerFault
Throws:
AuthFault
ServerFault

insertEventExceptionByExtId

java.lang.String insertEventExceptionByExtId(AccessToken token,
                                             java.lang.String parentEventExtId,
                                             java.util.Date OccurrenceDate,
                                             java.util.Date date,
                                             int duration,
                                             EventExceptionKind kind,
                                             java.lang.String extId,
                                             java.lang.String title)
                                             throws AuthFault,
                                                    ServerFault
Throws:
AuthFault
ServerFault

setAlert

void setAlert(AccessToken token,
              int eventId,
              int userId,
              java.lang.Integer alert)
              throws AuthFault,
                     ServerFault
Throws:
AuthFault
ServerFault

setParticipation

void setParticipation(AccessToken token,
                      java.util.List<java.lang.Integer> eventId,
                      java.lang.String entity,
                      int entityId,
                      ParticipationState ps,
                      boolean ownerNotification)
                      throws AuthFault,
                             ServerFault
Throws:
AuthFault
ServerFault

setParticipationByExtId

void setParticipationByExtId(AccessToken token,
                             java.util.List<java.lang.String> eventExtIds,
                             java.lang.String entity,
                             int entityId,
                             ParticipationState ps,
                             boolean ownerNotification)
                             throws AuthFault,
                                    ServerFault
Throws:
AuthFault
ServerFault

setParticipationWithNote

void setParticipationWithNote(AccessToken token,
                              java.util.List<java.lang.Integer> eventId,
                              java.lang.String entity,
                              int entityId,
                              ParticipationState ps,
                              boolean ownerNotification,
                              java.lang.String note)
                              throws AuthFault,
                                     ServerFault
Throws:
AuthFault
ServerFault

setParticipationByExtIdWithNote

void setParticipationByExtIdWithNote(AccessToken token,
                                     java.util.List<java.lang.String> eventExtIds,
                                     java.lang.String entity,
                                     int entityId,
                                     ParticipationState ps,
                                     boolean ownerNotification,
                                     java.lang.String note)
                                     throws AuthFault,
                                            ServerFault
Throws:
AuthFault
ServerFault

resetCalendar

void resetCalendar(AccessToken token,
                   int calendarId)
                   throws AuthFault,
                          ServerFault
Throws:
AuthFault
ServerFault

findFromPattern

ResultList<CalendarGroup> findFromPattern(AccessToken token,
                                          java.lang.String pattern,
                                          java.lang.String filter)
                                          throws AuthFault,
                                                 ServerFault
Throws:
AuthFault
ServerFault

doSync

@Deprecated
EventChanges doSync(AccessToken token,
                               java.util.Map<java.lang.Integer,java.util.Date> calendars,
                               EventChanges clientChanges,
                               java.util.Map<java.lang.String,EventPartNotification> notifications,
                               java.util.List<EventAlert> alerts)
                    throws AuthFault,
                           ServerFault
Deprecated. 

Throws:
AuthFault
ServerFault

doSync

@Deprecated
EventChanges doSync(AccessToken token,
                               SyncMode mode,
                               java.util.Map<java.lang.Integer,java.util.Date> calendars,
                               EventChanges clientChanges,
                               java.util.Map<java.lang.String,EventPartNotification> notifications,
                               java.util.List<EventAlert> alerts)
                    throws AuthFault,
                           ServerFault
Deprecated. 

Throws:
AuthFault
ServerFault

doSync

EventChanges doSync(AccessToken token,
                    java.util.List<SyncCalendar> syncCalendars,
                    EventChanges clientChanges,
                    java.util.Map<java.lang.String,EventPartNotification> notifications,
                    java.util.List<EventAlert> alerts)
                    throws AuthFault,
                           ServerFault
Synchronize Event data between the client and the bm-core. doSync(AccessToken, Map, EventChanges, Map, List) is a complex method that : This operation is done for each CalendarInfo's id / Date couple sent. The Date is the timestamp of the last synchronization. All changes done after this Date will be processed.

Parameters:
token - User who is charged for the synchronization.
calendars -
clientChanges - Changes done on the client-size
notifications -
alerts -
Returns:
Throws:
AuthFault
ServerFault

subscribe

void subscribe(AccessToken token,
               int userId,
               java.util.List<java.lang.Integer> calendarIds)
               throws AuthFault,
                      ServerFault
Throws:
AuthFault
ServerFault

unsubscribe

void unsubscribe(AccessToken token,
                 int userId,
                 java.util.List<java.lang.Integer> calendarIds)
                 throws AuthFault,
                        ServerFault
Throws:
AuthFault
ServerFault

getSubscription

CalendarInfo[] getSubscription(AccessToken token,
                               int userId)
                               throws AuthFault,
                                      ServerFault
Throws:
AuthFault
ServerFault

setSubscription

void setSubscription(AccessToken token,
                     int userId,
                     java.util.List<java.lang.Integer> calendarIds)
                     throws AuthFault,
                            ServerFault
Throws:
AuthFault
ServerFault

createCalendar

CalendarInfo createCalendar(AccessToken token,
                            CalendarInfo c)
                            throws AuthFault,
                                   ServerFault
Throws:
AuthFault
ServerFault

updateCalendar

CalendarInfo updateCalendar(AccessToken token,
                            CalendarInfo c)
                            throws AuthFault,
                                   ServerFault
Throws:
AuthFault
ServerFault

deleteCalendar

void deleteCalendar(AccessToken token,
                    int calendarId)
                    throws AuthFault,
                           ServerFault
Throws:
AuthFault
ServerFault

findCalendar

ResultList<CalendarInfo> findCalendar(AccessToken token,
                                      java.lang.String pattern,
                                      java.lang.String filter)
                                      throws AuthFault,
                                             ServerFault
Throws:
AuthFault
ServerFault

getCalendarFromId

CalendarInfo getCalendarFromId(AccessToken token,
                               int calendarId)
                               throws AuthFault,
                                      ServerFault
Throws:
AuthFault
ServerFault

findMe

User findMe(AccessToken token)
            throws AuthFault,
                   ServerFault
Throws:
AuthFault
ServerFault

findMyCalendars

ResultList<CalendarInfo> findMyCalendars(AccessToken token)
                                         throws ServerFault,
                                                AuthFault
Throws:
ServerFault
AuthFault

getPendingEventCount

int getPendingEventCount(AccessToken token)
                         throws ServerFault,
                                AuthFault
Throws:
ServerFault
AuthFault

getReminders

OccurrenceFactory getReminders(AccessToken token,
                               java.util.Date date)
                               throws ServerFault,
                                      AuthFault
Throws:
ServerFault
AuthFault

Blue Mind
Release 1.0