public interface AntimatroidSearch extends OsidSearch
The search interface for governing antimatroid searches.
Modifier and Type | Method and Description |
---|---|
AntimatroidSearchRecord |
getAntimatroidSearchRecord(Type antimatroidSearchRecordType)
Gets the antimatroid search record corresponding to the given
antimatroid search record
Type. |
void |
orderAntimatroidResults(AntimatroidSearchOrder antimatroidSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAntimatroids(IdList antimatroidIds)
Execute this search among the given list of antimatroids.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAntimatroids(IdList antimatroidIds)
antimatroidIds
- list of antimatroidsNullArgumentException
- antimatroidIds
is null
mandatory
- This method must be implemented. void orderAntimatroidResults(AntimatroidSearchOrder antimatroidSearchOrder)
antimatroidSearchOrder
- antimatroid search orderNullArgumentException
- antimatroidSearchOrder
is null
UnsupportedException
- antimatroidSearchOrder
is not of this servicemandatory
- This method must be implemented. AntimatroidSearchRecord getAntimatroidSearchRecord(Type antimatroidSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.antimatroidSearchRecordType
- an antimatroid search record typeNullArgumentException
-
antimatroidSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(antimatroidSearchRecordType)
is
false
mandatory
- This method must be implemented.