Interface | osid.hold.OublietteSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getOubliettes | ||
Description |
Gets the oubliette list resulting from a search. | ||
Return | osid.hold.OublietteList | the oubliette list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.hold.OublietteQueryInspector | the oubliette query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteSearchResultsRecord | ||
Description |
Gets the oubliette search results record corresponding
to the given oubliette search record | ||
Parameters | osid.type.Type | oublietteSearchRecordType | an oubliette search record type |
Return | osid.hold.records.OublietteSearchResultsRecord | the oubliette search results 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. |