org.osid.authorization

Interface QualifierSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.authorization.QualifierQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.