Interface | osid.calendaring.RecurringEventSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongRecurringEvents | ||
Description |
Execute this search among the given list of recurring events. | ||
Parameters | osid.id.IdList | recurringEventIds | list of recurring events |
Errors | NULL_ARGUMENT | recurringEventIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRecurringEventResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.calendaring.RecurringEventSearchOrder | recurringEventSearchOrder | recurring event search order |
Errors | NULL_ARGUMENT | recurringEventSearchOrder is null | |
UNSUPPORTED | recurringEventSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringEventSearchRecord | ||
Description |
Gets the recurring event record corresponding to the
given recurring event search record | ||
Parameters | osid.type.Type | recurringEventSearchRecordType | a recurring event search record type |
Return | osid.calendaring.records.RecurringEventSearchRecord | the recurring event search record | |
Errors | NULL_ARGUMENT | recurringEventSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(recurringEventSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |