Interface ProcedureSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcedureSearch
extends OsidSearch

The search interface for governing procedure searches.

Method Summary

Modifier and Type	Method	Description
ProcedureSearchRecord	getProcedureSearchRecord(Type procedureSearchRecordType)	Gets the procedure search record corresponding to the given procedure search record Type.
void	orderProcedureResults(ProcedureSearchOrder procedureSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcedures(IdList procedureIds)	Execute this search among the given list of procedures.

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

searchAmongProcedures

void searchAmongProcedures(IdList procedureIds)

Execute this search among the given list of procedures.

Parameters:

procedureIds - list of procedures

Throws:

NullArgumentException - procedureIds is null

Compliance:

mandatory - This method must be implemented.

orderProcedureResults

void orderProcedureResults(ProcedureSearchOrder procedureSearchOrder)

Specify an ordering to the search results.

Parameters:

procedureSearchOrder - procedure search order

Throws:

NullArgumentException - procedureSearchOrder is null

UnsupportedException - procedureSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcedureSearchRecord

ProcedureSearchRecord getProcedureSearchRecord(Type procedureSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

procedureSearchRecordType - a procedure search record type

Returns:

the procedure search record

Throws:

NullArgumentException - procedureSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.