org.osid.authentication.keys

Interface KeySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface KeySearchResults
extends OsidSearchResults

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();
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
KeyQueryInspector	getKeyQueryInspector() Gets the inspector for the query to examine the terms used in the search.
KeyList	getKeys() Gets the key list resulting from the search.
KeySearchResultsRecord	getKeySearchResultsRecord(Type keySearchRecordType) Gets the record corresponding to the given key search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getKeys

KeyList getKeys()

Gets the key list resulting from the search.

Returns:

the key list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getKeyQueryInspector

KeyQueryInspector getKeyQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getKeySearchResultsRecord

KeySearchResultsRecord getKeySearchResultsRecord(Type keySearchRecordType)
                                                 throws OperationFailedException

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

Parameters:

keySearchRecordType - a key search record type

Returns:

the key search results record

Throws:

NullArgumentException - keySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.