public interface VaultSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
VaultQueryInspector |
getVaultQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
VaultList |
getVaults()
Gets the vault list resulting from the search.
|
VaultSearchResultsRecord |
getVaultSearchResultsRecord(Type vaultSearchRecordType)
Gets the vault search results record corresponding to the given vault
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
VaultList getVaults()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. VaultQueryInspector getVaultQueryInspector()
mandatory
- This method must be implemented. VaultSearchResultsRecord getVaultSearchResultsRecord(Type vaultSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.vaultSearchRecordType
- a vault search record typeNullArgumentException
- vaultSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(vaultSearchRecordType)
is false
mandatory
- This method must be implemented.