Interface KeySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface KeySearch
extends OsidSearch

KeySearch defines options for governing key searches.

Method Summary

Modifier and Type	Method	Description
KeySearchRecord	getKeySearchRecord(Type keySearchRecordType)	Gets the record corresponding to the given key search record Type .
void	orderKeyResults(KeySearchOrder keySearchOrder)	Specify an ordering to the search results.
void	searchAmongKeys(IdList agentIds)	Execute this search among the given list of keys.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongKeys

void searchAmongKeys(IdList agentIds)

Execute this search among the given list of keys.

Parameters:

agentIds - list of agents

Throws:

NullArgumentException - agentIds is null

Compliance:

mandatory - This method must be implemented.

orderKeyResults

void orderKeyResults(KeySearchOrder keySearchOrder)

Specify an ordering to the search results.

Parameters:

keySearchOrder - key search order

Throws:

NullArgumentException - keySearchOrder is null

UnsupportedException - keySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getKeySearchRecord

KeySearchRecord getKeySearchRecord(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 record

Throws:

NullArgumentException - keySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.