OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.ItemSearch
Implementsosid.OsidSearch
Used Byosid.billing.ItemSearchSession
Description

The search interface for governing item searches.

MethodsearchAmongItems
Description

Execute this search among the given list of items.

Parametersosid.id.IdListitemIds list of items
ErrorsNULL_ARGUMENT itemIds is null
Compliancemandatory This method must be implemented.
MethodorderItemResults
Description

Specify an ordering to the search results.

Parametersosid.billing.ItemSearchOrderitemSearchOrder item search order
ErrorsNULL_ARGUMENT itemSearchOrder is null
UNSUPPORTED itemSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetItemSearchRecord
Description

Gets the item search record corresponding to the given item search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeitemSearchRecordType an item search record type
Returnosid.billing.records.ItemSearchRecord the item search record
ErrorsNULL_ARGUMENT itemSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(itemSearchRecordType) is false
Compliancemandatory This method must be implemented.