public interface InquestSearch extends OsidSearch
The search interface for governing inquest searches.
Modifier and Type | Method and Description |
---|---|
InquestSearchRecord |
getInquestSearchRecord(Type inquestSearchRecordType)
Gets the inquest search record corresponding to the given inquest
search record
Type. |
void |
orderInquestResults(InquestSearchOrder inquestSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongInquests(IdList inquestIds)
Execute this search among the given list of inquests.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongInquests(IdList inquestIds)
inquestIds
- list of inquestsNullArgumentException
- inquestIds
is
null
mandatory
- This method must be implemented. void orderInquestResults(InquestSearchOrder inquestSearchOrder)
inquestSearchOrder
- inquest search orderNullArgumentException
- inquestSearchOrder
is null
UnsupportedException
- inquestSearchOrder
is not of this servicemandatory
- This method must be implemented. InquestSearchRecord getInquestSearchRecord(Type inquestSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.inquestSearchRecordType
- an inquest search record typeNullArgumentException
- inquestSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquestSearchRecordType)
is false
mandatory
- This method must be implemented.