public interface DepotSearch extends OsidSearch
The interface for governing depot searches.
Modifier and Type | Method and Description |
---|---|
DepotSearchRecord |
getDepotSearchRecord(Type depotSearchRecordType)
Gets the depot search record corresponding to the given depot search
record
Type. |
void |
orderDepotResults(DepotSearchOrder depotSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDepots(IdList depotIds)
Execute this search among the given list of depots.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDepots(IdList depotIds)
depotIds
- list of depotsNullArgumentException
- depotIds
is
null
mandatory
- This method must be implemented. void orderDepotResults(DepotSearchOrder depotSearchOrder)
depotSearchOrder
- depot search orderNullArgumentException
- depotSearchOrder
is null
UnsupportedException
- depotSearchOrder
is not of this servicemandatory
- This method must be implemented. DepotSearchRecord getDepotSearchRecord(Type depotSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.depotSearchRecordType
- a depot search record typeNullArgumentException
- depotSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(depotSearchRecordType)
is false
mandatory
- This method must be implemented.