OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search. This example fetches all keys and orders them by the agent display name.

                     
                     
                     KeySearch ks = session.getKeySearch();
                     AgentSearch as = ks.getAgentSearch();
                     as.orderByDisplayName();
                     
                     KeyQuery keyQueries[1];
                     keyQueries[0] = session.getKeyQuery();
                     AgentQuery agQueries[1];
                     qgQueries[1].matchDisplayName("*", true);
                     KeySearchResults results = session.getKeysBySearch(keyQueries, ks);
                     
                     KeyList kl = results.getKeys();
                     
                                 
                     
                
MethodgetKeys
Description

Gets the key list resulting from the search.

Returnosid.authentication.keys.KeyListthe key list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetKeyQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.authentication.keys.KeyQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetKeySearchResultsRecord
Description

Gets the record corresponding to the given key search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypekeySearchRecordTypea key search record type
Returnosid.authentication.keys.records.KeySearchResultsRecordthe key search results record
ErrorsNULL_ARGUMENT keySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(keySearchRecordType) is false
CompliancemandatoryThis method must be implemented.