public interface GradebookQuerySession extends OsidSession
This session provides methods for searching among Gradebook
objects. The search query is constructed using the
GradebookQuery.
Gradebooks may have a query record indicated by their respective
record types. The query record is accessed via the GradebookQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchGradebooks()
Tests if this user can perform
Gradebook searches. |
GradebookQuery |
getGradebookQuery()
Gets a gradebook query.
|
GradebookList |
getGradebooksByQuery(GradebookQuery gradebookQuery)
Gets a list of
Gradebook objects matching the given
gradebook query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchGradebooks()
Gradebook
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. GradebookQuery getGradebookQuery()
mandatory
- This method must be implemented. GradebookList getGradebooksByQuery(GradebookQuery gradebookQuery) throws OperationFailedException, PermissionDeniedException
Gradebook
objects matching the given
gradebook query.gradebookQuery
- the gradebook query GradebookList
NullArgumentException
- gradebookQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradebookQuery
is
not of this servicemandatory
- This method must be implemented.