| Interface | osid.calendaring.rules.OffsetEventEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing offset event enabler searches. | ||
| Method | searchAmongOffsetEventEnablers | ||
| Description |
Execute this search among the given list of offset event enablers. | ||
| Parameters | osid.id.IdList | offsetEventEnablerIds | list of offset event enablers |
| Errors | NULL_ARGUMENT | offsetEventEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOffsetEventEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.calendaring.rules.OffsetEventEnablerSearchOrder | offsetEventEnablerSearchOrder | offset event enabler search order |
| Errors | NULL_ARGUMENT | offsetEventEnablerSearchOrder is null | |
| UNSUPPORTED | offsetEventEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffsetEventEnablerSearchRecord | ||
| Description |
Gets the offset event enabler search record
corresponding to the given offset event enabler search
record | ||
| Parameters | osid.type.Type | offsetEventEnablerSearchRecordType | an offset event enabler search record type |
| Return | osid.calendaring.rules.records.OffsetEventEnablerSearchRecord | the offset event enabler search record | |
| Errors | NULL_ARGUMENT | offsetEventEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offsetEventEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |