Interface | osid.calendaring.RecurringEventSmartCalendarSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the Calendar associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCalendars | ||
Description |
Tests if this user can manage smart calendars. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known all methods in
this session will result in a | ||
Return | boolean | false if smart calendar methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventQuery | ||
Description |
Gets a recurring event query. | ||
Return | osid.calendaring.RecurringEventQuery | the recurring event query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventSearchOrder | ||
Description |
Gets a recurring event search order. | ||
Return | osid.calendaring.RecurringEventSearchOrder | the recurring event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRecurringEventQuery | ||
Description |
Applies a recurring event query to this calendar. | ||
Parameters | osid.calendaring.RecurringEventQuery | recurringEventQuery | the recurring event query |
Errors | NULL_ARGUMENT | recurringEventQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | recurringEventQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRecurringEventQuery | ||
Description |
Gets a recurring event query inspector for this calendar. | ||
Return | osid.calendaring.RecurringEventQueryInspector | the recruring event query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRecurringEventSequencing | ||
Description |
Applies a recurring event search order to this calendar. | ||
Parameters | osid.calendaring.RecurringEventSearchOrder | recurringEventSearchOrder | the recurring event search order |
Errors | NULL_ARGUMENT | recurringEventSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | recurringEventSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventQueryFromInspector | ||
Description |
Gets a recurring event query from an inspector. | ||
Parameters | osid.calendaring.RecurringEventQueryInspector | recurringEventQueryInspector | a recurring event query inspector |
Return | osid.calendaring.RecurringEventQuery | the recurring event query | |
Errors | NULL_ARGUMENT | recruringEventQueryInspector is null | |
UNSUPPORTED | recurringEventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |