Interface VaultSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface VaultSearch
extends OsidSearch

The interface for governing vault searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongVaults

void searchAmongVaults(IdList vaultIds)

Execute this search among the given list of vaults.

Parameters:

vaultIds - list of vaults

Throws:

NullArgumentException - vaultIds is null

Compliance:

mandatory - This method must be implemented.

orderVaultResults

void orderVaultResults(VaultSearchOrder vaultSearchOrder)

Specify an ordering to the search results.

Parameters:

vaultSearchOrder - vault search order

Throws:

NullArgumentException - vaultSearchOrder is null

UnsupportedException - vaultSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getVaultSearchRecord

VaultSearchRecord getVaultSearchRecord(Type vaultSearchRecordType)
                                throws OperationFailedException

Gets the vault search record corresponding to the given vault search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

vaultSearchRecordType - a vault search record type

Returns:

the vault search record

Throws:

NullArgumentException - vaultSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.