com.stratelia.webactiv.calendar.control
Interface SilverpeasCalendar

All Known Implementing Classes:
CalendarEJB

public interface SilverpeasCalendar


Method Summary
 void addHolidayDate(HolidayDetail holiday)
           
 void addHolidayDates(List<HolidayDetail> holidayDates)
           
 String addJournal(JournalHeader journal)
          addJournal() add a journal entry in the database
 void addJournalAttendee(String journalId, Attendee attendee)
          methods for attendees
 void addJournalCategory(String journalId, String categoryId)
           
 String addToDo(ToDoHeader todo)
          addToDo() add a todo entry in the database
 void addToDoAttendee(String todoId, Attendee attendee)
           
 Collection<SchedulableCount> countMonthSchedulablesForUser(String month, String userId, String categoryId, String participation)
          countMonthSchedulablesForUser() for a particular user, counts the number of schedules for each day in the month
 Collection<Category> getAllCategories()
          methods for categories
 List<String> getAllToDoForUser(String userId)
           
 Category getCategory(String categoryId)
           
 Collection<ToDoHeader> getClosedToDos(String organizerId)
           
 Collection<JournalHeader> getDaySchedulablesForUser(String day, String userId, String categoryId, String participation)
          getDaySchedulablesForUser() for a particular user returns all the events scheduled on a particular day.
 Collection<JournalHeader> getExternalJournalHeadersForUser(String userId)
          getOutlookJournalHeadersForUser() returns the journalHeaders for user represented by the userId
 Collection<JournalHeader> getExternalJournalHeadersForUserAfterDate(String userId, Date startDate)
          getExternalJournalHeadersForUserAfterDate() returns the journalHeaders for user represented by the userId for which start date after given date
 Collection<ToDoHeader> getExternalTodos(String spaceId, String componentId, String externalId)
           
 List<String> getHolidayDates(String userId)
           
 List<String> getHolidayDates(String userId, Date beginDate, Date endDate)
           
 Collection<Attendee> getJournalAttendees(String journalId)
           
 Collection<Category> getJournalCategories(String journalId)
           
 JournalHeader getJournalHeader(String journalId)
          getJournalHeader() returns the journalHeader represented by the journalId
 Collection<JournalHeader> getJournalHeadersForUserAfterDate(String userId, Date startDate, int nbReturned)
          getJournalHeadersForUserAfterDate() returns the journalHeaders for user represented by the userId for which start date after given date
 List<SocialInformationEvent> getLastEventsForMyContacts(String day, String myId, List<String> myContactsIds, Date begin, Date end)
          get Last Social Events for a given list of my Contacts returns the next events (SocialInformationEvent).
 List<SocialInformationEvent> getMyLastEvents(String day, String myId, Date begin, Date end)
          get the my last Events of information and number of Item and the first Index includes all kinds of events
 Collection<JournalHeader> getNextDaySchedulablesForUser(String day, String userId, String categoryId, String participation)
          getNextDaySchedulablesForUser() for a particular user returns the next events scheduled.
 List<SocialInformationEvent> getNextEventsForMyContacts(String day, String myId, List<String> myContactsIds, Date begin, Date end)
          get Next Social Events for a given list of my Contacts returns the next events (SocialInformationEvent).
 List<JournalHeader> getNextEventsForUser(String day, String userId, String classification, Date begin, Date end)
          getNextEventForUser for a particular user returns the next events scheduled.
 Collection<ToDoHeader> getNotCompletedToDosForUser(String userId)
           
 Collection<ToDoHeader> getOrganizerToDos(String organizerId)
           
 Collection<JournalHeader> getPeriodSchedulablesForUser(String begin, String end, String userId, String categoryId, String participation)
          getPeriodSchedulablesForUser() for a particular user returns all the events scheduled during a particular period.
 Collection<JournalHeader> getTentativeSchedulablesForUser(String userId)
           
 Collection<Attendee> getToDoAttendees(String todoId)
           
 ToDoHeader getToDoHeader(String todoId)
          getToDoHeader() returns the ToDoHeader represented by the todoId
 boolean hasTentativeSchedulablesForUser(String userId)
          methods for tentative schedules (not yet accepted or declined events)
 void indexAllJournal()
           
 void indexAllTodo()
           
 boolean isHolidayDate(HolidayDetail date)
           
 void removeHolidayDate(HolidayDetail holiday)
           
 void removeHolidayDates(List<HolidayDetail> holidayDates)
           
 void removeJournal(String journalId)
          removeJournal() remove the journal entry specified by the id
 void removeJournalAttendee(String journalId, Attendee attendee)
           
 void removeJournalCategory(String journalId, String categoryId)
           
 void removeToDo(String id)
          removeToDo() remove the todo entry specified by the id
 void removeToDoAttendee(String todoId, Attendee attendee)
           
 void removeToDoByInstanceId(String instanceId)
          removeToDoByInstanceId remove all todo of the specified instance
 void setJournalAttendees(String journalId, String[] userIds)
           
 void setJournalCategories(String journalId, String[] categoryIds)
           
 void setJournalParticipationStatus(String journalId, String userId, String participation)
           
 void setToDoAttendees(String todoId, String[] userIds)
           
 void updateJournal(JournalHeader journal)
          updateJournal() update the journal entry, specified by the id, in the database
 void updateToDo(ToDoHeader todo)
          updateToDo() update the todo entry, specified by the id, in the database
 

Method Detail

getDaySchedulablesForUser

Collection<JournalHeader> getDaySchedulablesForUser(String day,
                                                    String userId,
                                                    String categoryId,
                                                    String participation)
getDaySchedulablesForUser() for a particular user returns all the events scheduled on a particular day. This includes all kinds of events


getNextDaySchedulablesForUser

Collection<JournalHeader> getNextDaySchedulablesForUser(String day,
                                                        String userId,
                                                        String categoryId,
                                                        String participation)
getNextDaySchedulablesForUser() for a particular user returns the next events scheduled. This includes all kinds of events


getNextEventsForUser

List<JournalHeader> getNextEventsForUser(String day,
                                         String userId,
                                         String classification,
                                         Date begin,
                                         Date end)
getNextEventForUser for a particular user returns the next events scheduled. This includes all kinds of events


getNextEventsForMyContacts

List<SocialInformationEvent> getNextEventsForMyContacts(String day,
                                                        String myId,
                                                        List<String> myContactsIds,
                                                        Date begin,
                                                        Date end)
get Next Social Events for a given list of my Contacts returns the next events (SocialInformationEvent). This includes all kinds of events


getLastEventsForMyContacts

List<SocialInformationEvent> getLastEventsForMyContacts(String day,
                                                        String myId,
                                                        List<String> myContactsIds,
                                                        Date begin,
                                                        Date end)
get Last Social Events for a given list of my Contacts returns the next events (SocialInformationEvent). This includes all kinds of events


getMyLastEvents

List<SocialInformationEvent> getMyLastEvents(String day,
                                             String myId,
                                             Date begin,
                                             Date end)
get the my last Events of information and number of Item and the first Index includes all kinds of events

Parameters:
:String - day,String myId , int numberOfElement, int firstIndex

getPeriodSchedulablesForUser

Collection<JournalHeader> getPeriodSchedulablesForUser(String begin,
                                                       String end,
                                                       String userId,
                                                       String categoryId,
                                                       String participation)
getPeriodSchedulablesForUser() for a particular user returns all the events scheduled during a particular period. This includes all kinds of events


countMonthSchedulablesForUser

Collection<SchedulableCount> countMonthSchedulablesForUser(String month,
                                                           String userId,
                                                           String categoryId,
                                                           String participation)
countMonthSchedulablesForUser() for a particular user, counts the number of schedules for each day in the month


hasTentativeSchedulablesForUser

boolean hasTentativeSchedulablesForUser(String userId)
methods for tentative schedules (not yet accepted or declined events)


getTentativeSchedulablesForUser

Collection<JournalHeader> getTentativeSchedulablesForUser(String userId)

getNotCompletedToDosForUser

Collection<ToDoHeader> getNotCompletedToDosForUser(String userId)

getAllToDoForUser

List<String> getAllToDoForUser(String userId)

getOrganizerToDos

Collection<ToDoHeader> getOrganizerToDos(String organizerId)

getClosedToDos

Collection<ToDoHeader> getClosedToDos(String organizerId)

getExternalTodos

Collection<ToDoHeader> getExternalTodos(String spaceId,
                                        String componentId,
                                        String externalId)

addJournal

String addJournal(JournalHeader journal)
addJournal() add a journal entry in the database


addToDo

String addToDo(ToDoHeader todo)
addToDo() add a todo entry in the database


updateJournal

void updateJournal(JournalHeader journal)
updateJournal() update the journal entry, specified by the id, in the database


updateToDo

void updateToDo(ToDoHeader todo)
updateToDo() update the todo entry, specified by the id, in the database


removeJournal

void removeJournal(String journalId)
removeJournal() remove the journal entry specified by the id


removeToDo

void removeToDo(String id)
removeToDo() remove the todo entry specified by the id


removeToDoByInstanceId

void removeToDoByInstanceId(String instanceId)
removeToDoByInstanceId remove all todo of the specified instance


getJournalHeader

JournalHeader getJournalHeader(String journalId)
getJournalHeader() returns the journalHeader represented by the journalId


getExternalJournalHeadersForUser

Collection<JournalHeader> getExternalJournalHeadersForUser(String userId)
getOutlookJournalHeadersForUser() returns the journalHeaders for user represented by the userId


getExternalJournalHeadersForUserAfterDate

Collection<JournalHeader> getExternalJournalHeadersForUserAfterDate(String userId,
                                                                    Date startDate)
getExternalJournalHeadersForUserAfterDate() returns the journalHeaders for user represented by the userId for which start date after given date


getJournalHeadersForUserAfterDate

Collection<JournalHeader> getJournalHeadersForUserAfterDate(String userId,
                                                            Date startDate,
                                                            int nbReturned)
getJournalHeadersForUserAfterDate() returns the journalHeaders for user represented by the userId for which start date after given date


getToDoHeader

ToDoHeader getToDoHeader(String todoId)
getToDoHeader() returns the ToDoHeader represented by the todoId


addJournalAttendee

void addJournalAttendee(String journalId,
                        Attendee attendee)
methods for attendees


removeJournalAttendee

void removeJournalAttendee(String journalId,
                           Attendee attendee)

getJournalAttendees

Collection<Attendee> getJournalAttendees(String journalId)

setJournalAttendees

void setJournalAttendees(String journalId,
                         String[] userIds)

setJournalParticipationStatus

void setJournalParticipationStatus(String journalId,
                                   String userId,
                                   String participation)

addToDoAttendee

void addToDoAttendee(String todoId,
                     Attendee attendee)

removeToDoAttendee

void removeToDoAttendee(String todoId,
                        Attendee attendee)

getToDoAttendees

Collection<Attendee> getToDoAttendees(String todoId)

setToDoAttendees

void setToDoAttendees(String todoId,
                      String[] userIds)

getAllCategories

Collection<Category> getAllCategories()
methods for categories


getCategory

Category getCategory(String categoryId)

getJournalCategories

Collection<Category> getJournalCategories(String journalId)

addJournalCategory

void addJournalCategory(String journalId,
                        String categoryId)

removeJournalCategory

void removeJournalCategory(String journalId,
                           String categoryId)

setJournalCategories

void setJournalCategories(String journalId,
                          String[] categoryIds)

indexAllTodo

void indexAllTodo()

indexAllJournal

void indexAllJournal()

isHolidayDate

boolean isHolidayDate(HolidayDetail date)

getHolidayDates

List<String> getHolidayDates(String userId)

getHolidayDates

List<String> getHolidayDates(String userId,
                             Date beginDate,
                             Date endDate)

addHolidayDate

void addHolidayDate(HolidayDetail holiday)

addHolidayDates

void addHolidayDates(List<HolidayDetail> holidayDates)

removeHolidayDate

void removeHolidayDate(HolidayDetail holiday)

removeHolidayDates

void removeHolidayDates(List<HolidayDetail> holidayDates)


Copyright © 2016 Silverpeas. All Rights Reserved.