public interface GradeSystemGradebookSession extends OsidSession
This session provides methods to retrieve GradeSystem
to
Gradebook
mappings. A GradeSystem
may appear
in multiple Gradebooks.
Each Gradebook
may
have its own authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGradeSystemGradebookMappings()
Tests if this user can perform lookups of gradebook/grade system
mappings.
|
IdList |
getGradebookIdsByGradeSystem(Id gradeSystemId)
Gets the list of
Gradebook Ids mapped to
a GradeSystem. |
GradebookList |
getGradebooksByGradeSystem(Id gradeSystemId)
Gets the list of
Gradebooks mapped to a
GradeSystem. |
IdList |
getGradeSystemIdsByGradebook(Id gradebookId)
Gets the list of
GradeSystem Ids
associated with a Gradebook. |
IdList |
getGradeSystemIdsByGradebooks(IdList gradebookIds)
Gets the list of
GradeSystem Ids corresponding to a
list of Gradebooks. |
GradeSystemList |
getGradeSystemsByGradebook(Id gradebookId)
Gets the list of grade systems associated with a
Gradebook. |
GradeSystemList |
getGradeSystemsByGradebooks(IdList gradebookIds)
Gets the list of grade systems corresponding to a list of
Gradebooks. |
void |
useComparativeGradebookView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryGradebookView()
A complete view of the
GradebookColumn and
Gradebook returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeGradebookView()
mandatory
- This method is must be implemented. void usePlenaryGradebookView()
GradebookColumn
and
Gradebook
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. boolean canLookupGradeSystemGradebookMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. IdList getGradeSystemIdsByGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystem
Ids
associated with a Gradebook.
gradebookId
- Id
of the Gradebook
Ids
NotFoundException
- gradebookId
is not
foundNullArgumentException
- gradebookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystemsByGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Gradebook.
gradebookId
- Id
of the Gradebook
NotFoundException
- gradebookId
is not
foundNullArgumentException
- gradebookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getGradeSystemIdsByGradebooks(IdList gradebookIds) throws OperationFailedException, PermissionDeniedException
GradeSystem Ids
corresponding to a
list of Gradebooks.
gradebookIds
- list of gradebook Ids
Ids
NullArgumentException
- gradebookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystemsByGradebooks(IdList gradebookIds) throws OperationFailedException, PermissionDeniedException
Gradebooks.
gradebookIds
- list of gradebook Ids
NullArgumentException
- gradebookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getGradebookIdsByGradeSystem(Id gradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Gradebook
Ids
mapped to
a GradeSystem.
gradeSystemId
- Id
of a GradeSystem
Ids
NotFoundException
- gradeSystemId
is not
foundNullArgumentException
- gradeSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooksByGradeSystem(Id gradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Gradebooks
mapped to a
GradeSystem.
gradeSystemId
- Id
of a GradeSystem
NotFoundException
- gradeSystemId
is not
foundNullArgumentException
- gradeSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.