org.osid.resource

Interface BinQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

BinSearchSession

public interface BinQuerySession
extends OsidSession

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

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
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 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

canSearchBins

boolean canSearchBins()

Tests if this user can perform Bin searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBinQuery

BinQuery getBinQuery()

Gets a bin query. The returned query will not have an extension query.

Returns:

the bin query

Compliance:

mandatory - This method must be implemented.

getBinsByQuery

BinList getBinsByQuery(BinQuery binQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Gets a list of Bins matching the given bin query.

Parameters:

binQuery - the bin query

Returns:

the returned BinList

Throws:

NullArgumentException - binQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - a binQuery is not of this service

Compliance:

mandatory - This method must be implemented.