OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.VaultSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getVaults | ||
| Description |
Gets the vault list resulting from the search. | ||
| Return | osid.authorization.VaultList | the vault list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.authorization.VaultQueryInspector | the vault query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultSearchResultsRecord | ||
| Description |
Gets the vault search results record corresponding to
the given vault search record | ||
| Parameters | osid.type.Type | vaultSearchRecordType | a vault search record type |
| Return | osid.authorization.records.VaultSearchResultsRecord | the vault search results record | |
| Errors | NULL_ARGUMENT | vaultSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(vaultSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |