public interface GradeSystemQuerySession extends OsidSession
This session provides methods for searching among GradeSystems.
The search query is constructed using the GradeSystemQuery.
This session defines views that offer differing behaviors for searching.
Grade systems may have a query record indicated by their respective
record types. The query record is accessed via the
GradeSystemQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchGradeSystems()
Tests if this user can perform
GradeSystem searches. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
GradeSystemQuery |
getGradeSystemQuery()
Gets a grade system query.
|
GradeSystemList |
getGradeSystemsByQuery(GradeSystemQuery gradeSystemQuery)
Gets a list of
GradeSystem objects matching the given
grade system 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 canSearchGradeSystems()
GradeSystem
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. GradeSystemQuery getGradeSystemQuery()
mandatory
- This method must be implemented. GradeSystemList getGradeSystemsByQuery(GradeSystemQuery gradeSystemQuery) throws OperationFailedException, PermissionDeniedException
GradeSystem
objects matching the given
grade system query.gradeSystemQuery
- the grade system query GradeSystemList
NullArgumentException
- gradeSystemQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- gradeSystemQuery
is not of this servicemandatory
- This method must be implemented.