OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.EntrySearchOrder
Implementsosid.OsidObjectSearchOrder
Description

This interface specifies options for ordering search results.

MethodorderByKeyType
Description

Specifies a preference for ordering the results by key type.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByKey
Description

Specifies a preference for ordering the results by key.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByValueType
Description

Specifies a preference for ordering the results by value type.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByValue
Description

Specifies a preference for ordering the results by value.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetEntrySearchOrderRecord
Description

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

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.dictionary.records.EntrySearchOrderRecordthe entry search order record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.