| Interface | osid.hold.OublietteSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing oubliette searches. | ||
| Method | searchAmongOubliettes | ||
| Description |
Execute this search among the given list of oubliettes. | ||
| Parameters | osid.id.IdList | oublietteIds | list of oubliettes |
| Errors | NULL_ARGUMENT | oublietteIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOublietteResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.hold.OublietteSearchOrder | oublietteSearchOrder | oubliette search order |
| Errors | NULL_ARGUMENT | oublietteSearchOrder is null | |
| UNSUPPORTED | oublietteSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOublietteSearchRecord | ||
| Description |
Gets the oubliette search record corresponding to the
given oubliette search record | ||
| Parameters | osid.type.Type | oublietteSearchRecordType | an oubliette search record type |
| Return | osid.hold.records.OublietteSearchRecord | the oubliette search record | |
| Errors | NULL_ARGUMENT | oublietteSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(oublietteSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |