Interface | osid.calendaring.cycle.CyclicTimePeriodSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongCyclicTimePeriods | ||
Description |
Execute this search among the given list of cyclic time periods. | ||
Parameters | osid.id.IdList | cyclicTimePeriodIds | list of cyclic time periods |
Errors | NULL_ARGUMENT | cyclicTimePeriodIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCyclicTimePeriodResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.cycle.CyclicTimePeriodSearchOrder | cyclicTimePeriodSearchOrder | cyclic time period search order |
Errors | NULL_ARGUMENT | cyclicTimePeriodSearchOrder is null | |
UNSUPPORTED | cyclicTimePeriodSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicTimePeriodSearchRecord | ||
Description |
Gets the cyclic time period search record corresponding
to the given cyclic time period search record | ||
Parameters | osid.type.Type | cyclicTimePeriodSearchRecordType | a cyclic time period search record type |
Return | osid.calendaring.cycle.records.CyclicTimePeriodSearchRecord | the cyclic time period search record | |
Errors | NULL_ARGUMENT | cyclicTimePeriodSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(cyclicTimePeriodSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |