OSID Logo
OSID Specifications
dictionary package
Version 3.1.0
Interfaceosid.dictionary.EntrySearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.dictionary.EntrySearchSession
osid.dictionary.EntrySmartDictionarySession
Description

This interface specifies options for ordering search results.

MethodorderByKeyType
Description

Specifies a preference for ordering the results by key type.

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

Specifies a preference for ordering the results by key.

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

Specifies a preference for ordering the results by value type.

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

Specifies a preference for ordering the results by value.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypeentryRecordType an entry record type
Returnosid.dictionary.records.EntrySearchOrderRecord the entry search order record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
Compliancemandatory This method must be implemented.