public interface ProvisionSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ProvisionQueryInspector |
getProvisionQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ProvisionList |
getProvisions()
Gets the provision list resulting from a search.
|
ProvisionSearchResultsRecord |
getProvisionSearchResultsRecord(Type provisionSearchRecordType)
Gets the provision search results record corresponding to the given
provision search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ProvisionList getProvisions()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ProvisionQueryInspector getProvisionQueryInspector()
mandatory
- This method must be implemented. ProvisionSearchResultsRecord getProvisionSearchResultsRecord(Type provisionSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.provisionSearchRecordType
- a provision search record typeNullArgumentException
-
provisionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionSearchRecordType)
is
false
mandatory
- This method must be implemented.