Interface | osid.calendaring.OffsetEventSmartCalendarSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An 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 | getOffsetEventQuery | ||
Description |
Gets an offset event query. | ||
Return | osid.calendaring.OffsetEventQuery | the offset event query | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventSearchOrder | ||
Description |
Gets an offset event search order. | ||
Return | osid.calendaring.OffsetEventSearchOrder | the offset event search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyOffsetEventQuery | ||
Description |
Applies an offset event query to this calendar. | ||
Parameters | osid.calendaring.OffsetEventQuery | offsetEventQuery | the offset event query |
Errors | NULL_ARGUMENT | offsetEventQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | offsetEventQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectOffsetEventQuery | ||
Description |
Gets an offset event query inspector for this calendar. | ||
Return | osid.calendaring.OffsetEventQueryInspector | the offset event query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyOffsetEventSequencing | ||
Description |
Applies an offset event search order to this calendar. | ||
Parameters | osid.calendaring.OffsetEventSearchOrder | offsetEventSearchOrder | the offset event search order |
Errors | NULL_ARGUMENT | offsetEventSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | offsetEventSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventQueryFromInspector | ||
Description |
Gets an offset event query from an inspector. | ||
Parameters | osid.calendaring.OffsetEventQueryInspector | offsetEventQueryInspector | an offset event query inspector |
Return | osid.calendaring.OffsetEventQuery | the offset event query | |
Errors | NULL_ARGUMENT | offsetEventQueryInspector is null | |
UNSUPPORTED | offsetEventQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |