public interface ProcedureSearch extends OsidSearch
The search interface for governing procedure searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProcedures(IdList procedureIds)
procedureIds
- list of proceduresNullArgumentException
- procedureIds
is
null
mandatory
- This method must be implemented. void orderProcedureResults(ProcedureSearchOrder procedureSearchOrder)
procedureSearchOrder
- procedure search orderNullArgumentException
- procedureSearchOrder
is null
UnsupportedException
- procedureSearchOrder
is not of this servicemandatory
- This method must be implemented. ProcedureSearchRecord getProcedureSearchRecord(Type procedureSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.procedureSearchRecordType
- a procedure search record typeNullArgumentException
-
procedureSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(procedureSearchRecordType)
is
false
mandatory
- This method must be implemented.