public interface GradebookColumnQuerySession extends OsidSession
This session provides methods for searching GradebookColumn
objects. The search query is constructed using the
GradebookColumnQuery.
This session defines views that offer differing behaviors for searching.
Gradebook columns may have a query record indicated by their
respective record types. The query record is accessed via the
GradebookColumnQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchGradebookColumns()
Tests if this user can perform
GradebookColumn
searches. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
GradebookColumnQuery |
getGradebookColumnQuery()
Gets a gradebook column query.
|
GradebookColumnList |
getGradebookColumnsByQuery(GradebookColumnQuery gradebookColumnQuery)
Gets a list of gradebook columns matching the given query.
|
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
void |
useFederatedGradebookView()
Federates the view for methods in this session.
|
void |
useIsolatedGradebookView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGradebookId()
Gradebook
Id
associated with
this session. Gradebook Id
associated with this sessionmandatory
- This method must be implemented. Gradebook getGradebook() throws OperationFailedException, PermissionDeniedException
Gradebook
associated with this session. Gradebook
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchGradebookColumns()
GradebookColumn
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. void useFederatedGradebookView()
mandatory
- This method is must be implemented. void useIsolatedGradebookView()
mandatory
- This method is must be implemented. GradebookColumnQuery getGradebookColumnQuery()
mandatory
- This method must be implemented. GradebookColumnList getGradebookColumnsByQuery(GradebookColumnQuery gradebookColumnQuery) throws OperationFailedException, PermissionDeniedException
gradebookColumnQuery
- the gradebook column query GradebookColumnList
NullArgumentException
- gradebookColumnQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradebookColumnQuery
is not of this servicemandatory
- This method must be implemented.