Interface | osid.calendaring.TimePeriodSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongTimePeriods | ||
Description |
Execute this search among the given list of time periods. | ||
Parameters | osid.id.IdList | timePeriodIds | list of time periods |
Errors | NULL_ARGUMENT | timePeriodIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderTimePeriodResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.TimePeriodSearchOrder | timePeriodSearchOrder | time period search order |
Errors | NULL_ARGUMENT | timePeriodSearchOrder is null | |
UNSUPPORTED | timePeriodSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodSearchRecord | ||
Description |
Gets the time period search record corresponding to the
given time period search record | ||
Parameters | osid.type.Type | timePeriodSearchRecordType | a time period search record type |
Return | osid.calendaring.records.TimePeriodSearchRecord | the time period search record | |
Errors | NULL_ARGUMENT | timePeriodSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(timePeriodSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |