OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CanonicalUnitSearch
Implementsosid.OsidSearch
Used Byosid.offering.CanonicalUnitSearchSession
Description

The search interface for governing canonical unit searches.

MethodsearchAmongCanonicalUnits
Description

Execute this search among the given list of canonical units.

Parametersosid.id.IdListcanonicalUnitIds list of canonical units
ErrorsNULL_ARGUMENT canonicalUnitIds is null
Compliancemandatory This method must be implemented.
MethodorderCanonicalUnitResults
Description

Specify an ordering to the search results.

Parametersosid.offering.CanonicalUnitSearchOrdercanonicalUnitSearchOrder canonical unit search order
ErrorsNULL_ARGUMENT canonicalUnitSearchOrder is null
UNSUPPORTED canonicalUnitSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCanonicalUnitSearchRecord
Description

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

Parametersosid.type.TypecanonicalUnitSearchRecordType a canonical unit search record type
Returnosid.offering.records.CanonicalUnitSearchRecord the canonical unit search record
ErrorsNULL_ARGUMENT canonicalUnitSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(canonicalUnitSearchRecordType) is false
Compliancemandatory This method must be implemented.