public interface GradebookColumnSmartGradebookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A GradebookColumnQuery
can be retrieved from this
session and mapped to this Gradebook
to create a virtual
collection of GradebookColumns.
The entries may be
sequenced using the GradebookColumnSearchOrder
from this
session.
This Gradebook
has a default query that matches any
gradebook column and a default search order that specifies no sequencing.
The queries may be examined using a GradebookColumnQueryInspector.
The query may be modified by converting the inspector back to a
GradebookColumnQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyGradebookColumnQuery(GradebookColumnQuery gradebookColumnQuery)
Applies a gradebook column query to this gradebook.
|
void |
applyGradebookColumnSequencing(GradebookColumnSearchOrder gradebookColumnSearchOrder)
Applies a gradebook column search order to this gradebook.
|
boolean |
canManageSmartGradebooks()
Tests if this user can manage smart gradebooks.
|
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
GradebookColumnQuery |
getGradebookColumnQuery()
Gets a gradebook column query.
|
GradebookColumnQuery |
getGradebookColumnQueryFromInspector(GradebookColumnQuery gradebookColumnQueryInspector)
Gets a gradebook column query from an inspector.
|
GradebookColumnSearchOrder |
getGradebookColumnSearchOrder()
Gets a gradebook column search order.
|
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
GradebookColumnQueryInspector |
inspectGradebookColumnQuery()
Gets a gradebook column 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. GradebookColumnQuery getGradebookColumnQuery()
mandatory
- This method must be implemented. GradebookColumnSearchOrder getGradebookColumnSearchOrder()
mandatory
- This method must be implemented. void applyGradebookColumnQuery(GradebookColumnQuery gradebookColumnQuery) throws OperationFailedException, PermissionDeniedException
gradebookColumnQuery
- the gradebook column queryNullArgumentException
- gradebookColumnQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- gradebookColumnQuery
not of this servicemandatory
- This method must be implemented. GradebookColumnQueryInspector inspectGradebookColumnQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyGradebookColumnSequencing(GradebookColumnSearchOrder gradebookColumnSearchOrder) throws OperationFailedException, PermissionDeniedException
gradebookColumnSearchOrder
- the gradebook column search orderNullArgumentException
-
gradebookColumnSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
gradebookColumnSearchOrder
not of this servicemandatory
- This method must be implemented. GradebookColumnQuery getGradebookColumnQueryFromInspector(GradebookColumnQuery gradebookColumnQueryInspector)
gradebookColumnQueryInspector
- a gradebook column query
inspectorNullArgumentException
-
gradebookColumnQueryInspector
is null
UnsupportedException
-
gradebookColumnQueryInspector
is not of this servicemandatory
- This method must be implemented.