OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.FunctionSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByQualifierHierarchy
Description

Specified a preference for ordering results by the qualifier hierarchy.

Parametersosid.SearchOrderStylestylethe search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsQualifierHierarchySearchOrder
Description

Tests if a HierarchySearchOrder interface is available.

Returnboolean true if a qualifier hierarchy search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQualifierHierarchySearchOrder
Description

Gets the search order interface for a qualifier hierarchy.

Returnosid.hierarchy.HierarchySearchOrderthe hierarchy search order
ErrorsUNIMPLEMENTED supportsQualifierHierarchySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsQualifierHierarchySearchOrder() is true.
MethodgetFunctionSearchOrderRecord
Description

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

Parametersosid.type.TypefunctionRecordTypea function record type
Returnosid.authorization.records.FunctionSearchOrderRecordthe function search order record
ErrorsNULL_ARGUMENT functionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(functionRecordType) is false
CompliancemandatoryThis method must be implemented.