Interface | osid.inventory.ItemSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing item searches. | ||
Method | searchAmongItems | ||
Description |
Execute this search among the given list of items. | ||
Parameters | osid.id.IdList | itemIds | list of items |
Errors | NULL_ARGUMENT | itemIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderItemResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.inventory.ItemSearchOrder | itemSearchOrder | item search order |
Errors | NULL_ARGUMENT | itemSearchOrder is null | |
UNSUPPORTED | itemSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemSearchRecord | ||
Description |
Gets the item search record corresponding to the given
item search record | ||
Parameters | osid.type.Type | itemSearchRecordType | a item search record type |
Return | osid.inventory.records.ItemSearchRecord | the item search record | |
Errors | NULL_ARGUMENT | itemSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(itemSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |