public interface VaultSearch extends OsidSearch
The interface for governing vault searches.
Modifier and Type | Method and Description |
---|---|
VaultSearchRecord |
getVaultSearchRecord(Type vaultSearchRecordType)
Gets the vault search record corresponding to the given vault search
record
Type. |
void |
orderVaultResults(VaultSearchOrder vaultSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongVaults(IdList vaultIds)
Execute this search among the given list of vaults.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongVaults(IdList vaultIds)
vaultIds
- list of vaultsNullArgumentException
- vaultIds
is
null
mandatory
- This method must be implemented. void orderVaultResults(VaultSearchOrder vaultSearchOrder)
vaultSearchOrder
- vault search orderNullArgumentException
- vaultSearchOrder
is null
UnsupportedException
- vaultSearchOrder
is not of this servicemandatory
- This method must be implemented. VaultSearchRecord getVaultSearchRecord(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.