OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.PoolProcessorSearchOrder
Implementsosid.OsidProcessorSearchOrder
Used Byosid.provisioning.rules.PoolProcessorSearchSession
osid.provisioning.rules.PoolProcessorSmartDistributorSession
Description

An interface for specifying the ordering of search results.

MethodorderByAllocatesByLeastUse
Description

Orders the results by allocates by least use.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodorderByAllocatesByMostUse
Description

Orders the results by allocates by most use.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodorderByAllocatesByLeastCost
Description

Orders the results by allocates by least cost.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodorderByAllocatesByMostCost
Description

Orders the results by allocates by most cost.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorSearchOrderRecord
Description

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

Parametersosid.type.TypepoolProcessorRecordTypea pool processor record type
Returnosid.provisioning.rules.records.PoolProcessorSearchOrderRecordthe pool processor search order record
ErrorsNULL_ARGUMENTpoolProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(poolProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.