Interface | osid.inventory.shipment.EntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing entry searches. | ||
Method | searchAmongEntries | ||
Description |
Execute this search among the given list of entries. | ||
Parameters | osid.id.IdList | entryIds | list of entries |
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.inventory.shipment.EntrySearchOrder | entrySearchOrder | entry search 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 | a entry search record type |
Return | osid.inventory.shipment.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. |