public interface EngineSearch extends OsidSearch
The search interface for governing engine searches.
Modifier and Type | Method and Description |
---|---|
EngineSearchRecord |
getEngineSearchRecord(Type engineSearchRecordType)
Gets the engine search record corresponding to the given engine search
record
Type. |
void |
orderEngineResults(EngineSearchOrder engineSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongEngines(IdList engineIds)
Execute this search among the given list of engines.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongEngines(IdList engineIds)
engineIds
- list of enginesNullArgumentException
- engineIds
is
null
mandatory
- This method must be implemented. void orderEngineResults(EngineSearchOrder engineSearchOrder)
engineSearchOrder
- engine search orderNullArgumentException
- engineSearchOrder
is null
UnsupportedException
- engineSearchOrder
is not of this servicemandatory
- This method must be implemented. EngineSearchRecord getEngineSearchRecord(Type engineSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object
implementing the requested record.engineSearchRecordType
- an engine search record typeNullArgumentException
- engineSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(engineSearchRecordType)
is false
mandatory
- This method must be implemented.