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

The search interface for governing canonical unit enabler searches.

MethodsearchAmongCanonicalUnitEnablers
Description

Execute this search among the given list of canonical unit enablers.

Parametersosid.id.IdListcanonicalUnitEnablerIdslist of canonical unit enablers
ErrorsNULL_ARGUMENT canonicalUnitEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCanonicalUnitEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.offering.rules.CanonicalUnitEnablerSearchOrdercanonicalUnitEnablerSearchOrdercanonical unit enabler search order
ErrorsNULL_ARGUMENT canonicalUnitEnablerSearchOrder is null
UNSUPPORTED canonicalUnitEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablerSearchRecord
Description

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

Parametersosid.type.TypecanonicalUnitEnablerSearchRecordTypea canonical unit enabler search record type
Returnosid.offering.rules.records.CanonicalUnitEnablerSearchRecordthe canonical unit enabler search record
ErrorsNULL_ARGUMENT canonicalUnitEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.