public interface DispatchSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
DispatchList |
getDispatches()
Gets the dispatch list resulting from a search.
|
DispatchQueryInspector |
getDispatchQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
DispatchSearchResultsRecord |
getDispatchSearchResultsRecord(Type dispatchSearchRecordType)
Gets the dispatch search results record corresponding to the given
dispatch search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DispatchList getDispatches()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. DispatchQueryInspector getDispatchQueryInspector()
mandatory
- This method must be implemented. DispatchSearchResultsRecord getDispatchSearchResultsRecord(Type dispatchSearchRecordType) throws OperationFailedException
dispatchSearchRecordType
- a dispatch search record typeNullArgumentException
- DispatchSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dispatchSearchRecordType)
is
false
mandatory
- This method must be implemented.