Interface | osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession | ||
---|---|---|---|
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 | getCyclicTimePeriodQuery | ||
Description |
Gets a cyclic time period query. | ||
Return | osid.calendaring.cycle.CyclicTimePeriodQuery | the cyclic time period query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodSearchOrder | ||
Description |
Gets a cyclic time period search order. | ||
Return | osid.calendaring.cycle.CyclicTimePeriodSearchOrder | the cyclic time period search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyCyclicTimePeriodQuery | ||
Description |
Applies a cyclic time period query to this calendar. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodQuery | cyclicTimePeriodQuery | the cyclic time period query |
Errors | NULL_ARGUMENT | cyclicTimePeriodQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | cyclicTimePeriodQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectCyclicTimePeriodQuery | ||
Description |
Gets a cyclic time period query inspector for this calendar. | ||
Return | osid.calendaring.cycle.CyclicTimePeriodQueryInspector | the cyclic time period query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyCyclicTimePeriodSequencing | ||
Description |
Applies a cyclic time period search order to this calendar. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodSearchOrder | cyclicTimePeriodSearchOrder | the cyclic time period search order |
Errors | NULL_ARGUMENT | cyclicTimePeriodSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | cyclicTimePeriodSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodQueryFromInspector | ||
Description |
Gets a cyclic time period query from an inspector. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodQueryInspector | cyclicTimePeriodQueryInspector | a cyclic time period query inspector |
Return | osid.calendaring.cycle.CyclicTimePeriodQuery | the cyclic time period query interface | |
Errors | NULL_ARGUMENT | cyclicTimePeriodQueryInspector is null | |
UNSUPPORTED | cyclicTimePeriodQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |