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

The search interface for governing canonical unit processor searches.

MethodsearchAmongCanonicalUnitProcessors
Description

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

Parametersosid.id.IdListcanonicalUnitProcessorIdslist of canonical unit processors
ErrorsNULL_ARGUMENT canonicalUnitProcessorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCanonicalUnitProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.offering.rules.CanonicalUnitProcessorSearchOrdercanonicalUnitProcessorSearchOrdercanonical unit processor search order
ErrorsNULL_ARGUMENT canonicalUnitProcessorSearchOrder is null
UNSUPPORTED canonicalUnitProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorSearchRecord
Description

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

Parametersosid.type.TypecanonicalUnitProcessorSearchRecordTypea canonical unit processor search record type
Returnosid.offering.rules.records.CanonicalUnitProcessorSearchRecordthe canonical unit processor search record
ErrorsNULL_ARGUMENT canonicalUnitProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.