public interface DocetSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
DocetQueryInspector |
getDocetQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
DocetList |
getDocets()
Gets the docet list resulting from a search.
|
DocetSearchResultsRecord |
getDocetSearchResultsRecord(Type docetSearchRecordType)
Gets the docet search results record corresponding to the given docet
search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DocetList getDocets()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. DocetQueryInspector getDocetQueryInspector()
mandatory
- This method must be implemented. DocetSearchResultsRecord getDocetSearchResultsRecord(Type docetSearchRecordType) throws OperationFailedException
docetSearchRecordType
- a docet search record typeNullArgumentException
- DocetSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetSearchRecordType)
is false
mandatory
- This method must be implemented.