Interface OublietteSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OublietteSearch
extends OsidSearch

The search interface for governing oubliette searches.

Method Summary

Modifier and Type	Method	Description
OublietteSearchRecord	getOublietteSearchRecord(Type oublietteSearchRecordType)	Gets the oubliette search record corresponding to the given oubliette search record Type.
void	orderOublietteResults(OublietteSearchOrder oublietteSearchOrder)	Specify an ordering to the search results.
void	searchAmongOubliettes(IdList oublietteIds)	Execute this search among the given list of oubliettes.

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

searchAmongOubliettes

void searchAmongOubliettes(IdList oublietteIds)

Execute this search among the given list of oubliettes.

Parameters:

oublietteIds - list of oubliettes

Throws:

NullArgumentException - oublietteIds is null

Compliance:

mandatory - This method must be implemented.

orderOublietteResults

void orderOublietteResults(OublietteSearchOrder oublietteSearchOrder)

Specify an ordering to the search results.

Parameters:

oublietteSearchOrder - oubliette search order

Throws:

NullArgumentException - oublietteSearchOrder is null

UnsupportedException - oublietteSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOublietteSearchRecord

OublietteSearchRecord getOublietteSearchRecord(Type oublietteSearchRecordType)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteSearchRecordType - an oubliette search record type

Returns:

the oubliette search record

Throws:

NullArgumentException - oublietteSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(oublietteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.