Interface QualifierSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, QualifierQuerySession

public interface QualifierSearchSession
extends QualifierQuerySession

This session provides methods for searching among Qualifier objects. The search query is constructed using the QualifierQuery. If more than one search element is specified within a single QualifierQuery, these elements form a boolean AND.

getQualifiersByQuery() is the basic search method and returns a list of Qualifiers. A more advanced search may be performed with getQualifiersBySearch().It accepts a QualifierSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getQualifiersBySearch() returns a QualifierSearchResults that can be used to access the resulting QualifierList or be used to perform a search within the result set through QualifierSearch.

This session defines views that offer differing behaviors for searching.

• federated vault view: searches include qualifiers in vaults of which this vault is an ancestor in the vault hierarchy
• isolated vault view: searches are restricted to qualifiers in this vault

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

Method Summary

Modifier and Type	Method	Description
QualifierQuery	getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)	Gets a qualifier query from an inspector.
QualifierSearchResults	getQualifiersBySearch(QualifierQuery qualifierQuery, QualifierSearch qualifierSearch)	Gets the search results matching the given search query using the given search.
QualifierSearch	getQualifierSearch()	Gets a qualifier search.
QualifierSearchOrder	getQualifierSearchOrder()	Gets a qualifier 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 QualifierQuerySession

canSearchQualifiers, getQualifierQuery, getQualifiersByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView

Modifier and Type	Method	Description
boolean	canSearchQualifiers()	Tests if this user can perform Qualifier searches.
QualifierQuery	getQualifierQuery()	Gets a qualifier query.
QualifierList	getQualifiersByQuery(QualifierQuery qualifierQuery)	Gets a list of Qualifiers matching the given search.
Vault	getVault()	Gets the Vault associated with this session.
Id	getVaultId()	Gets the Vault Id associated with this session.
void	useFederatedVaultView()	Federates the view for methods in this session.
void	useIsolatedVaultView()	Isolates the view for methods in this session.

Method Details

getQualifierSearch

QualifierSearch getQualifierSearch()

Gets a qualifier search.

Returns:

the qualifier search

Compliance:

mandatory - This method must be implemented.

getQualifierSearchOrder

QualifierSearchOrder getQualifierSearchOrder()

Gets a qualifier search order. The QualifierSearchOrder is supplied to a QualifierSearch to specify the ordering of results.

Returns:

the qualifier search order

Compliance:

mandatory - This method must be implemented.

getQualifiersBySearch

QualifierSearchResults getQualifiersBySearch(QualifierQuery qualifierQuery,
 QualifierSearch qualifierSearch)
                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

qualifierQuery - the qualifier query

qualifierSearch - the qualifier search

Returns:

the search results

Throws:

NullArgumentException - qualifierQueriy or qualifierSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - qualifierQuery or qualifierSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getQualifierQueryFromInspector

QualifierQuery getQualifierQueryFromInspector(QualifierQueryInspector qualifierQueryInspector)

Gets a qualifier query from an inspector. The inspector is available from a QualifierSearchResults.

Parameters:

qualifierQueryInspector - a qualifier query inspector

Returns:

the qualifier query

Throws:

NullArgumentException - qualifierQueryInspector is null

UnsupportedException - qualifierQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.