OSID Logo
OSID Specifications
dictionary package
Version 3.1.0
Interfaceosid.dictionary.EntrySearch
Implementsosid.OsidSearch
Used Byosid.dictionary.EntrySearchSession
Description

This interface specifies options for governing entry searches.

MethodsearchAmongEntries
Description

Execute this search among the given list of entries.

Parametersosid.id.IdListentryIds list of entry Ids
ErrorsNULL_ARGUMENT entryIds is null
Compliancemandatory This method must be implemented.
MethodorderEntryResults
Description

Specify an ordering to the search results.

Parametersosid.dictionary.EntrySearchOrderentrySearchOrder entry searcgh order
ErrorsNULL_ARGUMENT entrySearchOrder is null
UNSUPPORTED entrySearchOrder is not of this service
Compliancemandatory This 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.TypeentrySearchRecordType an entry search record type
Returnosid.dictionary.records.EntrySearchRecord the entry search record
ErrorsNULL_ARGUMENT entrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(entrySearchRecordType) is false
Compliancemandatory This method must be implemented.