OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
authorization package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authorization.VaultSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing vault searches. | ||
| Method | searchAmongVaults | ||
| Description |
Execute this search among the given list of vaults. | ||
| Parameters | osid.id.IdList | vaultIds | list of vaults |
| Errors | NULL_ARGUMENT | vaultIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderVaultResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.authorization.VaultSearchOrder | vaultSearchOrder | vault search order |
| Errors | NULL_ARGUMENT | vaultSearchOrder is null | |
| UNSUPPORTED | vaultSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultSearchRecord | ||
| Description |
Gets the vault search record corresponding to the given
vault search record | ||
| Parameters | osid.type.Type | vaultSearchRecordType | a vault search record type |
| Return | osid.authorization.records.VaultSearchRecord | the vault search 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. | |