OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisionableSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByPool
Description

Orders the results by pool.

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

Tests if a pool search order is available.

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

Gets the pool search order.

Returnosid.provisioning.PoolSearchOrderthe pool search order
ErrorsILLEGAL_STATE supportsPoolSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByResource
Description

Orders the results by resource.

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

Tests if a resource search order is available.

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

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsResourceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByUse
Description

Orders the results by use.

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

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

Parametersosid.type.TypeprovisionableRecordTypea provisionable record type
Returnosid.provisioning.records.ProvisionableSearchOrderRecordthe provisionable order record interface
ErrorsNULL_ARGUMENT provisionableRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionableRecordType) is false
CompliancemandatoryThis method must be implemented.