OSID Logo
OSID Specifications
authorization package
Version 3.1.0
Interfaceosid.authorization.FunctionSearchOrder
Implementsosid.OsidRuleSearchOrder
Used Byosid.authorization.AuthorizationSearchOrder
osid.authorization.FunctionSearchSession
osid.authorization.FunctionSmartVaultSession
osid.rules.check.CheckSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByQualifierHierarchy
Description

Specified a preference for ordering results by the qualifier hierarchy.

Parametersosid.SearchOrderStylestyle the search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetQualifierHierarchySearchOrder
Description

Gets the search order interface for a qualifier hierarchy.

Returnosid.hierarchy.HierarchySearchOrder the hierarchy search order
ErrorsUNIMPLEMENTED supportsQualifierHierarchySearchOrder() is false
Complianceoptional This 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.TypefunctionRecordType a function record type
Returnosid.authorization.records.FunctionSearchOrderRecord the function search order record
ErrorsNULL_ARGUMENT functionRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(functionRecordType) is false
Compliancemandatory This method must be implemented.