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

An interface for specifying the ordering of search results.

MethodorderByReturnDate
Description

Orders the results by the return date.

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

Orders the results by the returner.

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

Gets the resource search order.

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

Orders the results by the returning agent.

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

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReturningAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsReturningAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetProvisionReturnSearchOrderRecord
Description

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

Parametersosid.type.TypeprovisionReturnRecordTypea provision return record type
Returnosid.provisioning.records.ProvisionReturnSearchOrderRecordthe provision return search order record
ErrorsNULL_ARGUMENT provisionReturnRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionReturnRecordType) is false
CompliancemandatoryThis method must be implemented.