OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
dictionary package
Version 3.0.0
Release Candidate Preview
| Interface | osid.dictionary.EntrySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
This interface specifies options for governing entry searches. | ||
| Method | searchAmongEntries | ||
| Description |
Execute this search among the given list of entries. | ||
| Parameters | osid.id.IdList | entryIds | list of entry Ids |
| Errors | NULL_ARGUMENT | entryIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderEntryResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.dictionary.EntrySearchOrder | entrySearchOrder | entry searcgh order |
| Errors | NULL_ARGUMENT | entrySearchOrder is null | |
| UNSUPPORTED | entrySearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntrySearchRecord | ||
| Description |
Gets the entry search record corresponding to the given
entry search record | ||
| Parameters | osid.type.Type | entrySearchRecordType | an entry search record type |
| Return | osid.dictionary.records.EntrySearchRecord | the entry search record | |
| Errors | NULL_ARGUMENT | entrySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(entrySearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |