| org.sakaiproject.calendar.api.CalendarService
All known Subclasses: org.sakaiproject.calendar.impl.BaseCalendarService,
| CalendarService | | public interface CalendarService extends EntityProducer(Code) | | CalendarService is the interface for the Calendar service.
The service manages a set of calendars, each containing a set of events.
|
| Method Summary | |
| public CalendarEdit | addCalendar(String ref)
Add a new calendar.
Must commitCalendar() to make official, or cancelCalendar() when done!
Parameters:
ref - The new calendar reference. | | public boolean | allowEditCalendar(String ref)
check permissions for editCalendar() e.g. | | public boolean | allowGetCalendar(String ref)
check permissions for getCalendar().
Parameters:
ref - The calendar reference. | | public boolean | allowImportCalendar(String ref)
check permissions for importing calendar events
Parameters:
ref - The calendar reference. | | public boolean | allowMergeCalendar(String ref)
check permissions for mergeCalendar()
Parameters:
ref - The calendar reference. | | public String | calendarPdfReference(String context, String id, int scheduleType, String timeRangeString, String userName, TimeRange dailyTimeRange)
Access the internal reference which can be used to access the calendar-in-pdf format from within the system.
Parameters:
context - The context.
Parameters:
id - The calendar id. | | public String | calendarReference(String context, String id)
Access the internal reference which can be used to access the calendar from within the system.
Parameters:
context - The context.
Parameters:
id - The calendar id. | | public void | cancelCalendar(CalendarEdit edit)
Cancel the changes made to a CalendarEdit object, and release the lock. | | public void | commitCalendar(CalendarEdit edit)
Commit the changes made to a CalendarEdit object, and release the lock. | | public CalendarEdit | editCalendar(String ref)
Get a locked calendar object for editing.
Must commitCalendar() to make official, or cancelCalendar() or removeCalendar() when done!
Parameters:
ref - The calendar reference. | | public String | eventReference(String context, String calendarId, String id)
Access the internal reference which can be used to access the event from within the system.
Parameters:
context - The context.
Parameters:
calendarlId - The channel id.
Parameters:
id - The event id. | | public Calendar | getCalendar(String ref)
Return a specific calendar.
Parameters:
ref - The calendar reference. | | public List | getCalendars()
Return a List of all the defined calendars. | | public CalendarEventVector | getEvents(List references, TimeRange range)
Takes several calendar References and merges their events from within a given time range.
Parameters:
references - The List of calendar References.
Parameters:
range - The time period to use to select events. | | RecurrenceRule | newRecurrence(String frequency)
Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule. | | RecurrenceRule | newRecurrence(String frequency, int interval)
Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval. | | RecurrenceRule | newRecurrence(String frequency, int interval, int count)
Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval.
Parameters:
count - The number of reecurrences limit. | | RecurrenceRule | newRecurrence(String frequency, int interval, Time until)
Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval.
Parameters:
until - The time after which recurrences stop. | | public void | removeCalendar(CalendarEdit edit)
Remove a calendar that is locked for edit. |
| APPLICATION_ID | | final static String APPLICATION_ID(Code) | | The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
|
| AUTH_ADD_CALENDAR | | final public static String AUTH_ADD_CALENDAR(Code) | | Security lock for adding a calendar event
|
| AUTH_ALL_GROUPS_CALENDAR | | final public static String AUTH_ALL_GROUPS_CALENDAR(Code) | | Security function granted to users who will then have membership in all site groups based on their site membership.
|
| AUTH_IMPORT_CALENDAR | | final public static String AUTH_IMPORT_CALENDAR(Code) | | Security lock for importing events into a calendar.
|
| AUTH_MODIFY_CALENDAR_ANY | | final public static String AUTH_MODIFY_CALENDAR_ANY(Code) | | Security lock for changing any events (or fields) in a calendar.
|
| AUTH_MODIFY_CALENDAR_OWN | | final public static String AUTH_MODIFY_CALENDAR_OWN(Code) | | Security lock for changing user's own events in a calendar.
|
| AUTH_READ_CALENDAR | | final public static String AUTH_READ_CALENDAR(Code) | | Security lock for adding to a calendar.
|
| AUTH_REMOVE_CALENDAR_ANY | | final public static String AUTH_REMOVE_CALENDAR_ANY(Code) | | Security lock for removing any calendar event
|
| AUTH_REMOVE_CALENDAR_OWN | | final public static String AUTH_REMOVE_CALENDAR_OWN(Code) | | Security lock for removing user's own calendar event
|
| DAY_VIEW | | final public static int DAY_VIEW(Code) | | |
| EVENT_ADD_CALENDAR | | final public static String EVENT_ADD_CALENDAR(Code) | | Name for the event of adding a calendar event.
|
| EVENT_MODIFY_CALENDAR | | final public static String EVENT_MODIFY_CALENDAR(Code) | | Name for the event of removing or changing any events in a calendar.
|
| EVENT_REMOVE_CALENDAR | | final public static String EVENT_REMOVE_CALENDAR(Code) | | Name for the event of removing a calendar event
|
| LIST_VIEW | | final public static int LIST_VIEW(Code) | | |
| MOD_ALL | | final public static int MOD_ALL(Code) | | Recurring event modification intention: all.
|
| MOD_NA | | final public static int MOD_NA(Code) | | Recurring event modification intention: no intention.
|
| MOD_PRIOR | | final public static int MOD_PRIOR(Code) | | Recurring event modification intention: this and prior.
|
| MOD_REST | | final public static int MOD_REST(Code) | | Recurring event modification intention: this and subsequent.
|
| MOD_THIS | | final public static int MOD_THIS(Code) | | Recurring event modification intention: just this one.
|
| MONTH_VIEW | | final public static int MONTH_VIEW(Code) | | |
| REFERENCE_ROOT | | final public static String REFERENCE_ROOT(Code) | | This string starts the references to resources in this service.
|
| REF_TYPE_CALENDAR | | final public static String REF_TYPE_CALENDAR(Code) | | The Reference type for a calendar.
|
| REF_TYPE_CALENDAR_PDF | | final public static String REF_TYPE_CALENDAR_PDF(Code) | | The Reference type for a calendar pdf.
|
| REF_TYPE_EVENT | | final public static String REF_TYPE_EVENT(Code) | | The Reference type for an event.
|
| SECURE_ADD | | final public static String SECURE_ADD(Code) | | Security function / event for adding site / event.
|
| SECURE_ALL_GROUPS | | final public static String SECURE_ALL_GROUPS(Code) | | Security function giving the user permission to all groups, if granted to at the calendar or calendar level.
|
| SECURE_READ | | final public static String SECURE_READ(Code) | | Security function / event for reading site / event.
|
| SECURE_REMOVE | | final public static String SECURE_REMOVE(Code) | | Security function / event for removing event
|
| SECURE_UPDATE | | final public static String SECURE_UPDATE(Code) | | Security function / event for updating event.
|
| SESSION_CALENDAR_LIST | | final public static String SESSION_CALENDAR_LIST(Code) | | session attribute for list of all calendars user can reference
|
| UNKNOWN_VIEW | | final public static int UNKNOWN_VIEW(Code) | | Calendar Printing Views.
|
| WEEK_VIEW | | final public static int WEEK_VIEW(Code) | | |
| allowEditCalendar | | public boolean allowEditCalendar(String ref)(Code) | | check permissions for editCalendar() e.g. add/delete fields
Parameters:
ref - The calendar reference. true if the user is allowed to edit the calendar, false if not. |
| allowGetCalendar | | public boolean allowGetCalendar(String ref)(Code) | | check permissions for getCalendar().
Parameters:
ref - The calendar reference. true if the user is allowed to getCalendar(ref), false if not. |
| allowImportCalendar | | public boolean allowImportCalendar(String ref)(Code) | | check permissions for importing calendar events
Parameters:
ref - The calendar reference. true if the user is allowed to import events, false if not. |
| allowMergeCalendar | | public boolean allowMergeCalendar(String ref)(Code) | | check permissions for mergeCalendar()
Parameters:
ref - The calendar reference. true if the user is allowed to merge the calendar, false if not. |
| calendarPdfReference | | public String calendarPdfReference(String context, String id, int scheduleType, String timeRangeString, String userName, TimeRange dailyTimeRange)(Code) | | Access the internal reference which can be used to access the calendar-in-pdf format from within the system.
Parameters:
context - The context.
Parameters:
id - The calendar id. The the internal reference which can be used to access the calendar-in-pdf format from within the system. |
| calendarReference | | public String calendarReference(String context, String id)(Code) | | Access the internal reference which can be used to access the calendar from within the system.
Parameters:
context - The context.
Parameters:
id - The calendar id. The the internal reference which can be used to access the calendar from within the system. |
| cancelCalendar | | public void cancelCalendar(CalendarEdit edit)(Code) | | Cancel the changes made to a CalendarEdit object, and release the lock.
The CalendarEdit is disabled, and not to be used after this call.
Parameters:
edit - The CalendarEdit object to commit. |
| commitCalendar | | public void commitCalendar(CalendarEdit edit)(Code) | | Commit the changes made to a CalendarEdit object, and release the lock.
The CalendarEdit is disabled, and not to be used after this call.
Parameters:
edit - The CalendarEdit object to commit. |
| eventReference | | public String eventReference(String context, String calendarId, String id)(Code) | | Access the internal reference which can be used to access the event from within the system.
Parameters:
context - The context.
Parameters:
calendarlId - The channel id.
Parameters:
id - The event id. The the internal reference which can be used to access the event from within the system. |
| getCalendars | | public List getCalendars()(Code) | | Return a List of all the defined calendars.
a List of Calendar objects (may be empty) |
| getEvents | | public CalendarEventVector getEvents(List references, TimeRange range)(Code) | | Takes several calendar References and merges their events from within a given time range.
Parameters:
references - The List of calendar References.
Parameters:
range - The time period to use to select events. CalendarEventVector object with the union of all events from the list of calendars in the given time range. |
| newRecurrence | | RecurrenceRule newRecurrence(String frequency)(Code) | | Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule. A new recurrence rule. |
| newRecurrence | | RecurrenceRule newRecurrence(String frequency, int interval)(Code) | | Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval. A new recurrence rule. |
| newRecurrence | | RecurrenceRule newRecurrence(String frequency, int interval, int count)(Code) | | Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval.
Parameters:
count - The number of reecurrences limit. A new recurrence rule. |
| newRecurrence | | RecurrenceRule newRecurrence(String frequency, int interval, Time until)(Code) | | Construct a new recurrence rule who's frequency description matches the frequency parameter.
Parameters:
frequency - The frequency description of the desired rule.
Parameters:
interval - The recurrence interval.
Parameters:
until - The time after which recurrences stop. A new recurrence rule. |
|
|