public interface ModelSearch extends OsidSearch
The search interface for governing model searches.
Modifier and Type | Method and Description |
---|---|
ModelSearchRecord |
getModelSearchRecord(Type modelSearchRecordType)
Gets the model search record corresponding to the given model search
record
Type. |
void |
orderModelResults(ModelSearchOrder modelSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongModels(IdList modelIds)
Execute this search among the given list of models.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongModels(IdList modelIds)
modelIds
- list of modelsNullArgumentException
- modelIds
is
null
mandatory
- This method must be implemented. void orderModelResults(ModelSearchOrder modelSearchOrder)
modelSearchOrder
- model search orderNullArgumentException
- modelSearchOrder
is null
UnsupportedException
- modelSearchOrder
is not of this servicemandatory
- This method must be implemented. ModelSearchRecord getModelSearchRecord(Type modelSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.modelSearchRecordType
- a model search record typeNullArgumentException
- modelSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(modelSearchRecordType)
is false
mandatory
- This method must be implemented.