public interface ObjectiveBankQuerySession extends OsidSession
This session provides methods for searching among ObjectiveBank
objects. The search query is constructed using the
ObjectiveBankQuery.
ObjectiveBanks
may have a query record indicated by
their respective record types. The query record is accessed via the
ObjectiveBankQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchObjectiveBanks()
Tests if this user can perform
ObjectiveBank searches. |
ObjectiveBankQuery |
getObjectiveBankQuery()
Gets an objective bank query.
|
ObjectiveBankList |
getObjectiveBanksByQuery(ObjectiveBankQuery objectiveBankQuery)
Gets a list of
ObjectiveBank objects matching the given
objectiove bank query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchObjectiveBanks()
ObjectiveBank
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. ObjectiveBankQuery getObjectiveBankQuery()
mandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByQuery(ObjectiveBankQuery objectiveBankQuery) throws OperationFailedException, PermissionDeniedException
ObjectiveBank
objects matching the given
objectiove bank query.objectiveBankQuery
- the objective bank query ObjectiveBankList
NullArgumentException
- objectiveBankQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- objectiveBankQuery
is not of this servicemandatory
- This method must be implemented.