Interface VaultSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, VaultQuerySession

public interface VaultSearchSession
extends VaultQuerySession

This session provides methods for searching among Vault objects. The search query is constructed using the VaultQuery.

getVaultsByQuery() is the basic search method and returns a list of Vault objects.A more advanced search may be performed with getVaultsBySearch().It accepts a VaultSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getVaultsBySearch() returns a VaultSearchResults that can be used to access the resulting VaultList or be used to perform a search within the result set through VaultSearch.

Vaults may have a query record indicated by their respective record types. The query record is accessed via the VaultQuery.

Method Summary

Modifier and Type	Method	Description
VaultQuery	getVaultQueryFromInspector(VaultQueryInspector vaultQueryInspector)	Gets a vault query from an inspector.
VaultSearchResults	getVaultsBySearch(VaultQuery vaultQuery, VaultSearch vaultSearch)	Gets the search results matching the given search query using the given search.
VaultSearch	getVaultSearch()	Gets a vault search.
VaultSearchOrder	getVaultSearchOrder()	Gets a vault search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface VaultQuerySession

canSearchVaults, getVaultQuery, getVaultsByQuery

Modifier and Type	Method	Description
boolean	canSearchVaults()	Tests if this user can perform Vault searches.
VaultQuery	getVaultQuery()	Gets a vault query.
VaultList	getVaultsByQuery(VaultQuery vaultQuery)	Gets a list of Vault objects matching the given search.

Method Details

getVaultSearch

VaultSearch getVaultSearch()

Gets a vault search.

Returns:

a vault search

Compliance:

mandatory - This method must be implemented.

getVaultSearchOrder

VaultSearchOrder getVaultSearchOrder()

Gets a vault search order. The VaultSearchOrder is supplied to a VaultSearch to specify the ordering of results.

Returns:

the vault search order

Compliance:

mandatory - This method must be implemented.

getVaultsBySearch

VaultSearchResults getVaultsBySearch(VaultQuery vaultQuery,
 VaultSearch vaultSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

vaultQuery - the vault query

vaultSearch - the vault search

Returns:

the search results

Throws:

NullArgumentException - vaultQuery or vaultSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - vaultQuery or vaultSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getVaultQueryFromInspector

VaultQuery getVaultQueryFromInspector(VaultQueryInspector vaultQueryInspector)

Gets a vault query from an inspector. The inspector is available from a VaultSearchResults.

Parameters:

vaultQueryInspector - a vault query inspector

Returns:

the vault query

Throws:

NullArgumentException - vaultQueryInspector is null

UnsupportedException - vaultQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.