Interface RequisiteSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RequisiteSearch
extends OsidSearch

The search interface for governing requisite searches.

Method Summary

Modifier and Type	Method	Description
RequisiteSearchRecord	getRequisiteSearchRecord(Type requisiteSearchRecordType)	Gets the requisite search record corresponding to the given requisite search record Type .
void	orderRequisiteResults(RequisiteSearchOrder requisiteSearchOrder)	Specify an ordering to the search results.
void	searchAmongRequisites(IdList requisiteIds)	Execute this search among the given list of requisites.

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

searchAmongRequisites

void searchAmongRequisites(IdList requisiteIds)

Execute this search among the given list of requisites.

Parameters:

requisiteIds - list of requisite Ids

Throws:

NullArgumentException - requisiteIds is null

Compliance:

mandatory - This method must be implemented.

orderRequisiteResults

void orderRequisiteResults(RequisiteSearchOrder requisiteSearchOrder)

Specify an ordering to the search results.

Parameters:

requisiteSearchOrder - requisite search order

Throws:

NullArgumentException - requisiteSearchOrder is null

UnsupportedException - requisiteSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRequisiteSearchRecord

RequisiteSearchRecord getRequisiteSearchRecord(Type requisiteSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

requisiteSearchRecordType - a requisite search record type

Returns:

the requisite search record

Throws:

NullArgumentException - requisiteSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.