OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.EntrySearch
Implementsosid.OsidSearch
Description

The search interface for governing entry searches.

MethodsearchAmongEntries
Description

Execute this search among the given list of entries.

Parametersosid.id.IdListentryIdslist of entries
ErrorsNULL_ARGUMENT entryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEntryResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.shipment.EntrySearchOrderentrySearchOrderentry search order
ErrorsNULL_ARGUMENT entrySearchOrder is null
UNSUPPORTED entrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEntrySearchRecord
Description

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

Parametersosid.type.TypeentrySearchRecordTypea entry search record type
Returnosid.inventory.shipment.records.EntrySearchRecordthe entry search record
ErrorsNULL_ARGUMENT entrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.