OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySubject
Description

Specified a preference for ordering results by the subject.

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

Tests if a SubjectSearchOrder is available.

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

Gets the search order for a subject.

Returnosid.ontology.SubjectSearchOrderthe subject search order
ErrorsUNIMPLEMENTED supportsSubjectSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsSubjectSearchOrder() is true.
MethodgetRelevancySearchOrderRecord
Description

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

Parametersosid.type.TyperelevancyRecordTypea relevancy record type
Returnosid.ontology.records.RelevancySearchOrderRecordthe relevancy search order record
ErrorsNULL_ARGUMENT relevancyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancyRecordType) is false
CompliancemandatoryThis method must be implemented.