public interface GradeSystemSmartGradebookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A GradeSystemQuery
can be retrieved from this
session and mapped to this Gradebook
to create a virtual
collection of GradeSystems.
The entries may be sequenced
using the GradeSystemSearchOrder
from this session.
This Gradebook
has a default query that matches any
grade system and a default search order that specifies no sequencing. The
queries may be examined using a GradeSystemQueryInspector.
The query may be modified by converting the inspector back to a
GradeSystemQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyGradeSystemQuery(GradeSystemQuery gradeSystemQuery)
Applies a grade system query to this gradebook.
|
void |
applyGradeSystemSequencing(GradeSystemSearchOrder gradeSystemSearchOrder)
Applies a grade system search order to this gradebook.
|
boolean |
canManageSmartGradebooks()
Tests if this user can manage smart gradebooks.
|
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.
|
GradeSystemQuery |
getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)
Gets a grade system query from an inspector.
|
GradeSystemSearchOrder |
getGradeSystemSearchOrder()
Gets a grade system search order.
|
GradeSystemQueryInspector |
inspectGradeSystemQuery()
Gets a grade system query inspector for this gradebook.
|
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 canManageSmartGradebooks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer smart operations. false
if smart gradebook methods are not
authorized, true
otherwisemandatory
- This method must be implemented. GradeSystemQuery getGradeSystemQuery()
mandatory
- This method must be implemented. GradeSystemSearchOrder getGradeSystemSearchOrder()
mandatory
- This method must be implemented. void applyGradeSystemQuery(GradeSystemQuery gradeSystemQuery) throws OperationFailedException, PermissionDeniedException
gradeSystemQuery
- the grade system queryNullArgumentException
- gradeSystemQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- gradeSystemQuery
not of this servicemandatory
- This method must be implemented. GradeSystemQueryInspector inspectGradeSystemQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyGradeSystemSequencing(GradeSystemSearchOrder gradeSystemSearchOrder) throws OperationFailedException, PermissionDeniedException
gradeSystemSearchOrder
- the grade system search orderNullArgumentException
- gradeSystemSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- gradeSystemSearchOrder
not of this servicemandatory
- This method must be implemented. GradeSystemQuery getGradeSystemQueryFromInspector(GradeSystemQueryInspector gradeSystemQueryInspector)
gradeSystemQueryInspector
- a grade system query inspectorNullArgumentException
-
gradeSystemQueryInspector
is null
UnsupportedException
- gradeSystemQueryInspector
is not of this servicemandatory
- This method must be implemented.