Interface Search

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface Search
extends OsidSearch

The search interface for governing searches.

Method Summary

Modifier and Type	Method	Description
SearchRecord	getSearchRecord(Type searchRecordType)	Gets the search record corresponding to the given search record Type .
void	orderResults(SearchOrder searchOrder)	Specify an ordering to the search results.

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

orderResults

void orderResults(SearchOrder searchOrder)

Specify an ordering to the search results.

Parameters:

searchOrder - search order

Throws:

NullArgumentException - searchOrder is null

UnsupportedException - searchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSearchRecord

SearchRecord getSearchRecord(Type searchRecordType)
                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

searchRecordType - a search record type

Returns:

the search record

Throws:

NullArgumentException - searchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(searchRecordType) is false

Compliance:

mandatory - This method must be implemented.