OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.PoolSearchOrder
Implementsosid.OsidGovernatorSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBroker
Description

Orders the results by broker.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerSearchOrder
Description

Tests if a broker search order is available.

Returnboolean true if a broker search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerSearchOrder
Description

Gets the broker search order.

Returnosid.provisioning.BrokerSearchOrderthe broker search order
ErrorsILLEGAL_STATE supportsBrokerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderBySize
Description

Orders the results by pool size.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolSearchOrderRecord
Description

Gets the pool search order record corresponding to the given pool record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypepoolRecordTypea pool record type
Returnosid.provisioning.records.PoolSearchOrderRecordthe pool search order record
ErrorsNULL_ARGUMENT poolRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolRecordType) is false
CompliancemandatoryThis method must be implemented.