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

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Orders the results by resource.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search odrer
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsResourceSearchOrder() is true.
MethodgetAgentSearchOrderRecord
Description

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

Parametersosid.type.TypeagentRecordTypean agent record type
Returnosid.authentication.records.AgentSearchOrderRecordthe agent search order record
ErrorsNULL_ARGUMENT agentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agentRecordType) is false
CompliancemandatoryThis method must be implemented.