OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitSearch
Implementsosid.OsidSearch
Description

The search interface for governing canonical unit searches.

MethodsearchAmongCanonicalUnits
Description

Execute this search among the given list of canonical units.

Parametersosid.id.IdListcanonicalUnitIdslist of canonical units
ErrorsNULL_ARGUMENT canonicalUnitIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCanonicalUnitResults
Description

Specify an ordering to the search results.

Parametersosid.offering.CanonicalUnitSearchOrdercanonicalUnitSearchOrdercanonical unit search order
ErrorsNULL_ARGUMENT canonicalUnitSearchOrder is null
UNSUPPORTED canonicalUnitSearchOrder is not of this service
CompliancemandatoryThis 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.TypecanonicalUnitSearchRecordTypea canonical unit search record type
Returnosid.offering.records.CanonicalUnitSearchRecordthe canonical unit search record
ErrorsNULL_ARGUMENT canonicalUnitSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitSearchRecordType) is false
CompliancemandatoryThis method must be implemented.