public interface StepSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
StepQueryInspector |
getStepQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
StepList |
getSteps()
Gets the step list resulting from a search.
|
StepSearchResultsRecord |
getStepSearchResultsRecord(Type stepSearchRecordType)
Gets the step search results record corresponding to the given step
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
StepList getSteps()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. StepQueryInspector getStepQueryInspector()
mandatory
- This method must be implemented. StepSearchResultsRecord getStepSearchResultsRecord(Type stepSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.stepSearchRecordType
- a step search record typeNullArgumentException
- stepSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepSearchRecordType)
is false
mandatory
- This method must be implemented.