public interface GradeEntryLookupSession extends OsidSession
This session provides methods for retrieving GradeEntrie
s.
This session defines views that offer differing behaviors when retrieving multiple objects.
GradeEntryAdminSession.
Grade entries may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the GradeEntry.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGradeEntries()
Tests if this user can perform
GradeEntry lookups. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
GradeEntryList |
getGradeEntries()
Gets all grade entries.
|
GradeEntryList |
getGradeEntriesByGenusType(Type gradeEntryGenusType)
Gets a
GradeEntryList corresponding to the given grade
entry genus Type which does not include grade entries
of genus types derived from the specified Type. |
GradeEntryList |
getGradeEntriesByGrader(Id resourceId)
Gets a
GradeEntryList for the given grader. |
GradeEntryList |
getGradeEntriesByIds(IdList gradeEntryIds)
Gets a
GradeEntryList corresponding to the given
IdList. |
GradeEntryList |
getGradeEntriesByParentGenusType(Type gradeEntryGenusType)
Gets a
GradeEntryList corresponding to the given grade
entry genus Type and include any additional grade entry
with genus types derived from the specified Type. |
GradeEntryList |
getGradeEntriesByRecordType(Type gradeEntryRecordType)
Gets a
GradeEntryList containing the given grade entry
record Type. |
GradeEntryList |
getGradeEntriesForGradebookColumn(Id gradebookColumnId)
Gets a
GradeEntryList for the gradebook column. |
GradeEntryList |
getGradeEntriesForGradebookColumnAndResource(Id gradebookColumnId,
Id resourceId)
Gets a
GradeEntryList for the gradebook column and key
resource. |
GradeEntryList |
getGradeEntriesForGradebookColumnAndResourceOnDate(Id gradebookColumnId,
Id resourceId,
DateTime from,
DateTime to)
Gets a
GradeEntryList for the given gradebook column,
resource, and effective during the entire given date range inclusive
but not confined to the date range. |
GradeEntryList |
getGradeEntriesForGradebookColumnOnDate(Id gradebookColumnId,
DateTime from,
DateTime to)
Gets a
GradeEntryList for the given gradebook column
and effective during the entire given date range inclusive but not
confined to the date range. |
GradeEntryList |
getGradeEntriesForResource(Id resourceId)
Gets a
GradeEntryList for the given key key resource. |
GradeEntryList |
getGradeEntriesForResourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
GradeEntryList for the given key resource and
effective during the entire given date range inclusive but not
confined to the date range. |
GradeEntryList |
getGradeEntriesOnDate(DateTime from,
DateTime to)
Gets a
GradeEntryList effective during the entire given
date range inclusive but not confined to the date range. |
GradeEntry |
getGradeEntry(Id gradeEntryId)
Gets the
GradeEntry specified by its Id. |
void |
useAnyEffectiveGradeEntryView()
All grade entries of any effective dates are returned by methods in
this session.
|
void |
useComparativeGradeEntryView()
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 |
useEffectiveGradeEntryView()
Only grade entries whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedGradebookView()
Federates the view for methods in this session.
|
void |
useIsolatedGradebookView()
Isolates the view for methods in this session.
|
void |
usePlenaryGradeEntryView()
A complete view of the
GradeEntry 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 canLookupGradeEntries()
GradeEntry
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 useComparativeGradeEntryView()
mandatory
- This method is must be implemented. void usePlenaryGradeEntryView()
GradeEntry
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. void useEffectiveGradeEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveGradeEntryView()
mandatory
- This method is must be implemented. GradeEntry getGradeEntry(Id gradeEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeEntry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
GradeEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a GradeEntry
and retained for
compatibility.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradeEntryId
- Id
of the GradeEntry
NotFoundException
- gradeEntryId
not
foundNullArgumentException
- gradeEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradeEntryList getGradeEntriesByIds(IdList gradeEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradeEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
grade entries specified in the Id
list, in the order of
the list, including duplicates, or an error results if a Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible grade entries may be omitted from the list and may
present the elements in any order including returning a unique set.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradeEntryIds
- the list of Ids
to retrieve GradeEntry
listNotFoundException
- an Id was
not foundNullArgumentException
- gradeEntryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesByGenusType(Type gradeEntryGenusType) throws OperationFailedException, PermissionDeniedException
GradeEntryList
corresponding to the given grade
entry genus Type
which does not include grade entries
of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
grade entries or an error results. Otherwise, the returned list may
contain only those grade entries that are accessible through this
session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradeEntryGenusType
- a grade entry genus type GradeEntry
listNullArgumentException
- gradeEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesByParentGenusType(Type gradeEntryGenusType) throws OperationFailedException, PermissionDeniedException
GradeEntryList
corresponding to the given grade
entry genus Type
and include any additional grade entry
with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
grade entries or an error results. Otherwise, the returned list may
contain only those grade entries that are accessible through this
session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradeEntryGenusType
- a grade entry genus type GradeEntry
listNullArgumentException
- gradeEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesByRecordType(Type gradeEntryRecordType) throws OperationFailedException, PermissionDeniedException
GradeEntryList
containing the given grade entry
record Type.
In plenary mode, the returned list contains all known
grade entries or an error results. Otherwise, the returned list may
contain only those grade entries that are accessible through this
session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradeEntryRecordType
- a grade entry record type GradeEntry
listNullArgumentException
- gradeEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
GradeEntryList
effective during the entire given
date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.from
- start of date rangeto
- end of date range GradeEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForGradebookColumn(Id gradebookColumnId) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the gradebook column.
In plenary mode, the returned list contains all known
grade entries or an error results. Otherwise, the returned list may
contain only those grade entries that are accessible through this
session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradebookColumnId
- a gradebook column Id
GradeEntry
listNullArgumentException
- gradebookColumnId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForGradebookColumnOnDate(Id gradebookColumnId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the given gradebook column
and effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradebookColumnId
- a gradebook column Id
from
- start of date rangeto
- end of date range GradeEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- gradebookColumnId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the given key key resource.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.resourceId
- a key resource Id
GradeEntry
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the given key resource and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range GradeEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForGradebookColumnAndResource(Id gradebookColumnId, Id resourceId) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the gradebook column and key
resource.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradebookColumnId
- a gradebook column Id
resourceId
- a key resource Id
GradeEntry
listNullArgumentException
- gradebookColumnId
or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesForGradebookColumnAndResourceOnDate(Id gradebookColumnId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the given gradebook column,
resource, and effective during the entire given date range inclusive
but not confined to the date range.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.gradebookColumnId
- a gradebook column Id
resourceId
- a key resource Id
from
- start of date rangeto
- end of date range GradeEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- gradebookColumnId,
resource, from, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntriesByGrader(Id resourceId) throws OperationFailedException, PermissionDeniedException
GradeEntryList
for the given grader.
In plenary mode, the returned list contains all known grade entries or
an error results. Otherwise, the returned list may contain only those
grade entries that are accessible through this session.
In effective mode, grade entries are returned that are currently
effective. In any effective mode, effective grade entries and those
currently expired are returned.resourceId
- a resource Id
GradeEntry
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradeEntryList getGradeEntries() throws OperationFailedException, PermissionDeniedException
GradeEntryList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.