public interface EffortSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
EffortQueryInspector |
getEffortQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
EffortList |
getEfforts()
Gets the effort list resulting from a search.
|
EffortSearchResultsRecord |
getEffortSearchResultsRecord(Type effortSearchRecordType)
Gets the effort search results record corresponding to the given
effort search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
EffortList getEfforts()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. EffortQueryInspector getEffortQueryInspector()
mandatory
- This method must be implemented. EffortSearchResultsRecord getEffortSearchResultsRecord(Type effortSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.effortSearchRecordType
- an effort search record typeNullArgumentException
- effortSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(effortSearchRecordType)
is false
mandatory
- This method must be implemented.