OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTitle
Description

Specifies a preference for ordering the result set by the title.

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

Specifies a preference for ordering the result set by the code.

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

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

Parametersosid.type.TypecanonicalUnitRecordTypea canonical unit record type
Returnosid.offering.records.CanonicalUnitSearchOrderRecordthe canonical unit search order record
ErrorsNULL_ARGUMENT canonicalUnitRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitRecordType) is false
CompliancemandatoryThis method must be implemented.