public interface GradeSystemTransformLookupSession extends OsidSession
The session defines methods for retrieving
GradeSystemTransformations.
Two views are defined in this session:
Grades system transformations 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 |
canLookupGradeSystemTransforms()
Tests if this user can lookup grade articulations.
|
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
GradeSystemTransform |
getGradeSystemTransform(Id gradeSystemTransformId)
Gets the
GradeSystemTransform specified by its
Id. |
GradeSystemTransform |
getGradeSystemTransformBySystems(Id sourceGradeSystemId,
Id targetGradeSystemId)
Gets a grade system transform by its source and target grade systems.
|
GradeSystemTransformList |
getGradeSystemTransforms()
Gets all
GradeSystemTransforms. |
GradeSystemTransformList |
getGradeSystemTransformsByGenusType(Type gradeSystemTransformGenusType)
Gets a
GradeSystemTransformList corresponding to the
given grade system transform genus Type which does not
include transforms of genus types derived from the specified
Type. |
GradeSystemTransformList |
getGradeSystemTransformsByIds(IdList gradeSystemTransformIdList)
Gets a
GradeSystemTransformList corresponding to the
given IdList. |
GradeSystemTransformList |
getGradeSystemTransformsByParentGenusType(Type gradeSystemTransformGenusType)
Gets a
GradeSystemTransformList corresponding to the
given grade system transform genus Type and include any
additional transforms with genus types derived from the specified
Type. |
GradeSystemTransformList |
getGradeSystemTransformsByRecordType(Type gradeSystemTransformRecordType)
Gets a
GradeSystemTransformList containing the given
grade record Type. |
GradeSystemTransformList |
getGradeSystemTransformsBySource(Id sourceGradeSystemId)
Gets the grade system transforms from the source grade system.
|
void |
useActiveGradeSystemTransformView()
Only active grade system transformations are returned by methods in
this session.
|
void |
useAnyStatusGradeSystemTransformView()
All active and inactive grade system transformations are returned by
methods in this session.
|
void |
useComparativeGradeSystemTransformView()
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 |
usePlenaryGradeSystemTransformView()
A complete view of the
GradeSystemTransform returns is
desired. |
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 canLookupGradeSystemTransforms()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if articulation lookup 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. void useComparativeGradeSystemTransformView()
mandatory
- This method is must be implemented. void usePlenaryGradeSystemTransformView()
GradeSystemTransform
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 useActiveGradeSystemTransformView()
mandatory
- This method is must be implemented. void useAnyStatusGradeSystemTransformView()
mandatory
- This method is must be implemented. GradeSystemTransform getGradeSystemTransform(Id gradeSystemTransformId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystemTransform
specified by its
Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
GradeSystemTransform
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a GradeSystemTransform
and retained for
compatibility.gradeSystemTransformId
- Id
of the
GradeSystemTransform
NotFoundException
- gradeSystemTransformId
not foundNullArgumentException
- gradeSystemTransformId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradeSystemTransformList getGradeSystemTransformsByIds(IdList gradeSystemTransformIdList) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeSystemTransformList
corresponding to the
given IdList.
In plenary mode, the returned list
contains all of the transforms 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 GradeSystemTransforms
may be omitted from the list and may present the elements in
any order including returning a unique set.gradeSystemTransformIdList
- the list of Ids
to
retrieve GradeSystemTransform
listNotFoundException
- an Id was
not foundNullArgumentException
-
gradeSystemTransformIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransformList getGradeSystemTransformsByGenusType(Type gradeSystemTransformGenusType) throws OperationFailedException, PermissionDeniedException
GradeSystemTransformList
corresponding to the
given grade system transform genus Type
which does not
include transforms of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
transforms or an error results. Otherwise, the returned list may
contain only those transforms that are accessible through this
session.gradeSystemTransformGenusType
- a grade system transform genus
type GradeSystemTransform
listNullArgumentException
-
gradeSystemTransformGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransformList getGradeSystemTransformsByParentGenusType(Type gradeSystemTransformGenusType) throws OperationFailedException, PermissionDeniedException
GradeSystemTransformList
corresponding to the
given grade system transform genus Type
and include any
additional transforms with genus types derived from the specified
Type.
In plenary mode, the returned list contains all
known transforms or an error results. Otherwise, the returned list may
contain only those transforms that are accessible through this
session.gradeSystemTransformGenusType
- a grade system transform genus
type GradeSystemTransform
listNullArgumentException
-
gradeSystemTransformGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransformList getGradeSystemTransformsByRecordType(Type gradeSystemTransformRecordType) throws OperationFailedException, PermissionDeniedException
GradeSystemTransformList
containing the given
grade record Type.
In plenary mode, the returned list
contains all known transforms or an error results. Otherwise, the
returned list may contain only those transforms that are accessible
through this session.gradeSystemTransformRecordType
- a grade system transform record
type GradeSystemTransform
listNullArgumentException
-
gradeSystemTransformGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransformList getGradeSystemTransformsBySource(Id sourceGradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
sourceGradeSystemId
- the source grade system GradeSystemTransform
listNotFoundException
- sourceGradeSystemId
not foundNullArgumentException
- sourceGradeSystemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransform getGradeSystemTransformBySystems(Id sourceGradeSystemId, Id targetGradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
sourceGradeSystemId
- the source grade systemtargetGradeSystemId
- the target grade system GradeSystemTransform
NotFoundException
- transform not foundNullArgumentException
- sourceGradeSystemId
or targetGradeSystemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeSystemTransformList getGradeSystemTransforms() throws OperationFailedException, PermissionDeniedException
GradeSystemTransforms.
In plenary mode, the
returned list contains all known grade system transforms or an error
results. Otherwise, the returned list may contain only those grade
system transforms that are accessible through this session. GradeSystemTransformList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.