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

An interface for specifying the ordering of search results.

MethodorderByBroker
Description

Orders the results by the 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.
MethodorderByProvisionable
Description

Orders the results by the provisionable.

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

Tests if a provisionable search order is available.

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

Gets the provisionable search order.

Returnosid.provisioning.ProvisionableSearchOrderthe provisionable search order
ErrorsILLEGAL_STATE supportsProvisionableSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByRecipient
Description

Orders the results by the recipient.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipientSearchOrder
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.
MethodgetRecipientSearchOrder
Description

Gets the resource search order.

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

Orders the results by the request.

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

Tests if a request search order is available.

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

Gets the request search order.

Returnosid.provisioning.RequestSearchOrderthe request search order
ErrorsILLEGAL_STATE supportsRequestSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByProvisionDate
Description

Orders the results by the provision date.

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

Orders the results by the leased flag.

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

Orders the results by the must return flag.

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

Orders the results by the due date.

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

Orders the results by the cost.

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

Orders the results by the rate amount and period.

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

Orders the results by returned.

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

Tests if a provision return search order is available.

Returnboolean true if a provision return search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProvisionReturnSearchOrder
Description

Gets the provision return search order.

Returnosid.provisioning.ProvisionReturnSearchOrderthe provision return search order
ErrorsILLEGAL_STATE supportsProvisionReturnSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetProvisionSearchOrderRecord
Description

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

Parametersosid.type.TypeprovisionRecordTypea provision record type
Returnosid.provisioning.records.ProvisionSearchOrderRecordthe provision search order record
ErrorsNULL_ARGUMENT provisionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionRecordType) is false
CompliancemandatoryThis method must be implemented.