Interface | osid.calendaring.cycle.CyclicTimePeriodSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.cycle.CyclicTimePeriodQuerySession | ||
Description |
This session provides methods for searching Cyclic time periods may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getCyclicTimePeriodSearch | ||
Description |
Gets a cyclic time period search. | ||
Return | osid.calendaring.cycle.CyclicTimePeriodSearch | the cyclic time period search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodSearchOrder | ||
Description |
Gets a cyclic time period search order. The | ||
Return | osid.calendaring.cycle.CyclicTimePeriodSearchOrder | the cyclic time period search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodQuery | cyclicTimePeriodQuery | the cyclic time period query |
osid.calendaring.cycle.CyclicTimePeriodSearch | cyclicTimePeriodSearch | the cyclic time period search | |
Return | osid.calendaring.cycle.CyclicTimePeriodSearchResults | the cyclic time period search results | |
Errors | NULL_ARGUMENT | cyclicTimePeriodQuery or cyclicTimePeriodSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cyclicTimePeriodSearch or t imePeriodQuery is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodQueryFromInspector | ||
Description |
Gets a cyclic time period query from an inspector. The
inspector is available from a | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodQueryInspector | cyclicTimePeriodQueryInspector | a cyclic time period query inspector |
Return | osid.calendaring.cycle.CyclicTimePeriodQuery | the cyclic time period query | |
Errors | NULL_ARGUMENT | cyclicTimePeriodQueryInspector is null | |
UNSUPPORTED | cyclicTimePeriodQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |