Interface | osid.calendaring.TimePeriodSearchSession | ||
---|---|---|---|
Implements | osid.calendaring.TimePeriodQuerySession | ||
Description |
This session provides methods for searching Time periods may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getTimePeriodSearch | ||
Description |
Gets a time period search. | ||
Return | osid.calendaring.TimePeriodSearch | the time period search | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodSearchOrder | ||
Description |
Gets a time period search order. The | ||
Return | osid.calendaring.TimePeriodSearchOrder | the time period search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.calendaring.TimePeriodQuery | timePeriodQuery | the time period query |
osid.calendaring.TimePeriodSearch | timePeriodSearch | the time period search | |
Return | osid.calendaring.TimePeriodSearchResults | the time period search results | |
Errors | NULL_ARGUMENT | timePeriodQuery or timePeriodSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | timePeriodSearch or t imePeriodQuery is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodQueryFromInspector | ||
Description |
Gets a time period query from an inspector. The
inspector is available from a | ||
Parameters | osid.calendaring.TimePeriodQueryInspector | timePeriodQueryInspector | a time period query inspector |
Return | osid.calendaring.TimePeriodQuery | the time period query | |
Errors | NULL_ARGUMENT | timePeriodQueryInspector is null | |
UNSUPPORTED | timePeriodQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |