OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CanonicalUnitSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Used Byosid.offering.CanonicalUnitSearchSession
osid.offering.CanonicalUnitSmartCatalogueSession
osid.offering.OfferingSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTitle
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByCode
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypecanonicalUnitRecordType a canonical unit record type
Returnosid.offering.records.CanonicalUnitSearchOrderRecord the canonical unit search order record
ErrorsNULL_ARGUMENT canonicalUnitRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(canonicalUnitRecordType) is false
Compliancemandatory This method must be implemented.