Interface | osid.hold.rules.HoldEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing hold enabler searches. | ||
Method | searchAmongHoldEnablers | ||
Description |
Execute this search among the given list of hold enablers. | ||
Parameters | osid.id.IdList | holdEnablerIds | list of hold enablers |
Errors | NULL_ARGUMENT | holdEnablerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderHoldEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.hold.rules.HoldEnablerSearchOrder | holdEnablerSearchOrder | hold enabler search order |
Errors | NULL_ARGUMENT | holdEnablerSearchOrder is null | |
UNSUPPORTED | holdEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getHoldEnablerSearchRecord | ||
Description |
Gets the hold enabler search record corresponding to
the given hold enabler search record | ||
Parameters | osid.type.Type | holdEnablerSearchRecordType | a hold enabler search record type |
Return | osid.hold.rules.records.HoldEnablerSearchRecord | the hold enabler search record | |
Errors | NULL_ARGUMENT | holdEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(holdEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |