org.osid.resource

Interface BinSearchSession

All Superinterfaces:

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

Methods

Modifier and Type	Method and 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 org.osid.resource.BinQuerySession

canSearchBins, getBinQuery, getBinsByQuery

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

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.