OSID Logo
OSID Specifications
offering package
Version 3.0.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.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle 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_ARGUMENTstyle 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_ARGUMENTcanonicalUnitRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(canonicalUnitRecordType) is false
CompliancemandatoryThis method must be implemented.