public interface InputSearch extends OsidSearch
The search interface for governing input searches.
Modifier and Type | Method and Description |
---|---|
InputSearchRecord |
getInputSearchRecord(Type inputSearchRecordType)
Gets the input search record corresponding to the given input search
record
Type. |
void |
orderInputResults(InputSearchOrder inputSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongInputs(IdList inputIds)
Execute this search among the given list of inputs.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongInputs(IdList inputIds)
inputIds
- list of inputsNullArgumentException
- inputIds
is
null
mandatory
- This method must be implemented. void orderInputResults(InputSearchOrder inputSearchOrder)
inputSearchOrder
- input search orderNullArgumentException
- inputSearchOrder
is null
UnsupportedException
- inputSearchOrder
is not of this servicemandatory
- This method must be implemented. InputSearchRecord getInputSearchRecord(Type inputSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.inputSearchRecordType
- an input search record typeNullArgumentException
- inputSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inputSearchRecordType)
is false
mandatory
- This method must be implemented.