OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeySearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodsupportsAgentSearchOrder
Description

Tests if an AgentSearchOrder is available.

Returnboolean true if an agent search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented is supportsAgentSearchOrder() is true.
MethodgetKeySearchOrderRecord
Description

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

Parametersosid.type.TypekeyRecordTypea key record type
Returnosid.authentication.keys.records.KeySearchOrderRecordthe key search order record
ErrorsNULL_ARGUMENT keyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(keyRecordType) is false
CompliancemandatoryThis method must be implemented.