Interface BinSearchSession

All Superinterfaces:

AutoCloseable, BinQuerySession, Closeable, OsidSession, OsidSession

public interface BinSearchSession
extends BinQuerySession

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

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

Bins may have a bin query record indicated by their respective record types. The bin query record is accessed via the BinQuery.

Method Summary

Modifier and Type	Method	Description
BinQuery	getBinQueryFromInspector(BinQueryInspector binQueryInspector)	Gets a bin query from an inspector.
BinSearchResults	getBinsBySearch(BinQuery binQuery, BinSearch binSearch)	Gets the search results matching the given search query using the given search.
BinSearch	getBinSearch()	Gets a bin search.
BinSearchOrder	getBinSearchOrder()	Gets a bin search order.

Methods inherited from interface BinQuerySession

canSearchBins, getBinQuery, getBinsByQuery

Modifier and Type	Method	Description
boolean	canSearchBins()	Tests if this user can perform Bin searches.
BinQuery	getBinQuery()	Gets a bin query.
BinList	getBinsByQuery(BinQuery binQuery)	Gets a list of Bins matching the given bin query.

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.

Method Details

getBinSearch

BinSearch getBinSearch()

Gets a bin search.

Returns:

the bin search

Compliance:

mandatory - This method must be implemented.

getBinSearchOrder

BinSearchOrder getBinSearchOrder()

Gets a bin search order. The BinSearchOrder is supplied to a BinSearch to specify the ordering of results.

Returns:

the bin search order

Compliance:

mandatory - This method must be implemented.

getBinsBySearch

BinSearchResults getBinsBySearch(BinQuery binQuery,
 BinSearch binSearch)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

binQuery - the bin query

binSearch - the bin search

Returns:

the bin search results

Throws:

NullArgumentException - binQuery or binSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - binQuery or binSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBinQueryFromInspector

BinQuery getBinQueryFromInspector(BinQueryInspector binQueryInspector)

Gets a bin query from an inspector. The inspector is available from a BinSearchResults.

Parameters:

binQueryInspector - a bin query inspector

Returns:

the bin query

Throws:

NullArgumentException - binQueryInspector is null

UnsupportedException - binQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.