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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchBins()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. BinQuery getBinQuery()
mandatory
- This method must be implemented. BinList getBinsByQuery(BinQuery binQuery) throws OperationFailedException, PermissionDeniedException
Bins
matching the given bin query.binQuery
- the bin query BinList
NullArgumentException
- binQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- a binQuery
is not
of this servicemandatory
- This method must be implemented.