public interface GradeEntryQuerySession extends OsidSession
This session provides methods for searching GradeEntry
objects. The search query is constructed using the GradeEntryQuery.
The grade entry record Type
also specifies the
record interface for the grade entry query.
This session defines views that offer differing behaviors for searching.
Grade entries may have a query record indicated by their respective
record types. The query record is accessed via the GradeEntryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchGradeEntries()
Tests if this user can perform
GradeEntry searches. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
GradeEntryList |
getGradeEntriesByQuery(GradeEntryQuery gradeEntryQuery)
Gets a list of entries matching the given grade entry query.
|
GradeEntryQuery |
getGradeEntryQuery()
Gets a grade entry query.
|
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 canSearchGradeEntries()
GradeEntry
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. GradeEntryQuery getGradeEntryQuery()
mandatory
- This method must be implemented. GradeEntryList getGradeEntriesByQuery(GradeEntryQuery gradeEntryQuery) throws OperationFailedException, PermissionDeniedException
gradeEntryQuery
- the grade entry query GradeEntryList
NullArgumentException
- gradeEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradeEntryQuery
is not of this servicemandatory
- This method must be implemented.