public interface GradeSystemLookupSession extends OsidSession
The session defines methods for retrieving Grades
and
GradeSystems.
A Grade represents a qualified ranking
defined in some grade system.
Two views are defined in this session:
Grades and grade systems may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the object.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGradeSystems()
Tests if this user can perform
GradeSystem lookups. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
GradeSystem Id associated with
this session. |
GradeSystem |
getGradeSystem(Id gradeSystemId)
Gets the
GradeSystem specified by its Id. |
GradeSystem |
getGradeSystemByGrade(Id gradeId)
Gets the
GradeSystem by a Grade
Id. |
GradeSystemList |
getGradeSystems()
Gets all
GradeSystems. |
GradeSystemList |
getGradeSystemsByGenusType(Type gradeSystemGenusType)
Gets a
GradeSystemList corresponding to the given grade
system genus Type which does not include systems of
genus types derived from the specified Type. |
GradeSystemList |
getGradeSystemsByIds(IdList gradeSystemIds)
Gets a
GradeSystemList corresponding to the given
IdList. |
GradeSystemList |
getGradeSystemsByParentGenusType(Type gradeSystemGenusType)
Gets a
GradeSystemList corresponding to the given grade
system genus Type and include any additional systems
with genus types derived from the specified Type. |
GradeSystemList |
getGradeSystemsByRecordType(Type gradeSystemRecordType)
Gets a
GradeSystemList containing the given grade
record Type. |
void |
useComparativeGradeSystemView()
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 |
useFederatedGradebookView()
Federates the view for methods in this session.
|
void |
useIsolatedGradebookView()
Isolates the view for methods in this session.
|
void |
usePlenaryGradeSystemView()
A complete view of the
GradeSystem returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGradebookId()
GradeSystem
Id
associated with
this session. GradeSystem 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 canLookupGradeSystems()
GradeSystem
lookups. 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 lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeGradeSystemView()
mandatory
- This method is must be implemented. void usePlenaryGradeSystemView()
GradeSystem
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. void useFederatedGradebookView()
mandatory
- This method is must be implemented. void useIsolatedGradebookView()
mandatory
- This method is must be implemented. GradeSystem getGradeSystem(Id gradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystem
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
GradeSystem
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a GradeSystem
and retained for
compatibility.gradeSystemId
- Id
of the GradeSystem
NotFoundException
- gradeSystemId
not
foundNullArgumentException
- gradeSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradeSystem getGradeSystemByGrade(Id gradeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystem
by a Grade
Id.
gradeId
- Id
of a Grade
NotFoundException
- gradeId
not foundNullArgumentException
- gradeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradeSystemList getGradeSystemsByIds(IdList gradeSystemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystemList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the systems specified in the Id
list, in the order
of the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible GradeSystems
may be omitted from the list
and may present the elements in any order including returning a unique
set.gradeSystemIds
- the list of Ids
to retrieve GradeSystem
listNotFoundException
- an Id was
not foundNullArgumentException
- gradeSystemIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystemsByGenusType(Type gradeSystemGenusType) throws OperationFailedException, PermissionDeniedException
GradeSystemList
corresponding to the given grade
system genus Type
which does not include systems of
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known systems or an error
results. Otherwise, the returned list may contain only those systems
that are accessible through this session.gradeSystemGenusType
- a grade system genus type GradeSystem
listNullArgumentException
- gradeSystemGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystemsByParentGenusType(Type gradeSystemGenusType) throws OperationFailedException, PermissionDeniedException
GradeSystemList
corresponding to the given grade
system genus Type
and include any additional systems
with genus types derived from the specified Type.
In
plenary mode, the returned list contains all known systems or an error
results. Otherwise, the returned list may contain only those systems
that are accessible through this session.gradeSystemGenusType
- a grade system genus type GradeSystem
listNullArgumentException
- gradeSystemGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystemsByRecordType(Type gradeSystemRecordType) throws OperationFailedException, PermissionDeniedException
GradeSystemList
containing the given grade
record Type.
In plenary mode, the returned list
contains all known systems or an error results. Otherwise, the
returned list may contain only those systems that are accessible
through this session.gradeSystemRecordType
- a grade system record type GradeSystem
listNullArgumentException
- gradeSystemGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemList getGradeSystems() throws OperationFailedException, PermissionDeniedException
GradeSystems.
In plenary mode, the returned
list contains all known grade systems or an error results. Otherwise,
the returned list may contain only those grade systems that are
accessible through this session. GradeSystemList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.