public interface ProvisionableSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ProvisionableQueryInspector |
getProvisionableQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ProvisionableList |
getProvisionables()
Gets the provisionable list resulting from a search.
|
ProvisionableSearchResultsRecord |
getProvisionableSearchResultsRecord(Type provisionableSearchRecordType)
Gets the provisionable search results record corresponding to the
given provisionable search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ProvisionableList getProvisionables()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ProvisionableQueryInspector getProvisionableQueryInspector()
mandatory
- This method must be implemented. ProvisionableSearchResultsRecord getProvisionableSearchResultsRecord(Type provisionableSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.provisionableSearchRecordType
- a provisionable search record
typeNullArgumentException
-
provisionableSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionableSearchRecordType)
is
false
mandatory
- This method must be implemented.