public interface AssessmentEntryLookupSession extends OsidSession
This session defines methods for retrieving entriesand entry components.
This lookup session defines several views:
AssessmentEntries
with the
AssessmentEntry AdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
AssessmentEntries may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the AssessmentEntry.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAssessmentEntries()
Tests if this user can perform
AssessmentEntry lookups. |
AssessmentEntryList |
getAssessmentEntries()
Gets all
AssessmentEntries. |
AssessmentEntryList |
getAssessmentEntriesByGenusType(Type assessmentEntryGenusType)
Gets an
AssessmentEntryList corresponding to the given
assessment entry genus Type which does not include
assessments of types derived from the specified Type. |
AssessmentEntryList |
getAssessmentEntriesByIds(IdList assessmentEntryId)
Gets an
AssessmentEntryList corresponding to the given
IdList. |
AssessmentEntryList |
getAssessmentEntriesByParentGenusType(Type assessmentEntryGenusType)
Gets an
AssessmentEntryList corresponding to the given
assessment entry genus Type and include any additional
assessments with genus types derived from the specified Type. |
AssessmentEntryList |
getAssessmentEntriesByRecordType(Type assessmentEntryRecordType)
Gets an
AssessmentEntryList containing the given
assessment entry record Type. |
AssessmentEntryList |
getAssessmentEntriesForAssessment(Id assessmentId)
Gets an
AssessmentEntryList for the given assessment. |
AssessmentEntryList |
getAssessmentEntriesForAssessmentOnDate(Id assessmentId,
DateTime from,
DateTime to)
Gets an
AssessmentEntryList for the given assessment
effective during the entire given date range inclusive but not
confined to the date range. |
AssessmentEntryList |
getAssessmentEntriesForStudent(Id resourceId)
Gets an
AssessmentEntryList for the given student
. |
AssessmentEntryList |
getAssessmentEntriesForStudentAndAssessment(Id resourceId,
Id assessmentId)
Gets an
AssessmentEntryList for the given student and
assessment . |
AssessmentEntryList |
getAssessmentEntriesForStudentAndAssessmentOnDate(Id resourceId,
Id assessmentId,
DateTime from,
DateTime to)
Gets an
AssessmentEntryList for the given student and
assessment effective during the entire given date range inclusive but
not confined to the date range. |
AssessmentEntryList |
getAssessmentEntriesForStudentOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets an
AssessmentEntryList for the given student
effective during the entire given date range inclusive but not
confined to the date range. |
AssessmentEntryList |
getAssessmentEntriesOnDate(DateTime from,
DateTime to)
Gets an
AssessmentEntryList effectiveduring the entire
given date range inclusive but not confined to the date range. |
AssessmentEntry |
getAssessmentEntry(Id assessmentEntryId)
Gets the
AssessmentEntry specified by its Id. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
useAnyEffectiveAssessmentEntryView()
All assessment entries of any effective dates are returned by methods
in this session.
|
void |
useComparativeAssessmentEntryView()
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 |
useEffectiveAssessmentEntryView()
Only assessment entries whose effective dates are current are returned
by methods in this session.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryAssessmentEntryView()
A complete view of the
AssessmentEntry returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAssessmentEntries()
AssessmentEntry
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAssessmentEntryView()
mandatory
- This method is must be implemented. void usePlenaryAssessmentEntryView()
AssessmentEntry
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 useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useEffectiveAssessmentEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveAssessmentEntryView()
mandatory
- This method is must be implemented. AssessmentEntry getAssessmentEntry(Id assessmentEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AssessmentEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AssessmentEntry
and retained for
compatibility.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentEntryId
- the Id
of the
AssessmentEntry
to retrieve chronicle
NotFoundException
- no AssessmentEntry
found with the given Id
NullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByIds(IdList assessmentEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
assessments 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 AssessmentEntries
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentEntryId
- the list of Ids
to retrieve AssessmentEntryList
NotFoundException
- an Id was
not foundNullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByGenusType(Type assessmentEntryGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
corresponding to the given
assessment entry genus Type
which does not include
assessments of types derived from the specified Type.
In plenary mode, the returned list contains all known
assessments or an error results. Otherwise, the returned list may
contain only those assessments that are accessible through this
session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentEntryGenusType
- an assessment entry genus type AssessmentEntryList
NullArgumentException
- assessmentEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByParentGenusType(Type assessmentEntryGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
corresponding to the given
assessment entry genus Type
and include any additional
assessments with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
assessments or an error results. Otherwise, the returned list may
contain only those assessments that are accessible through this
session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentEntryGenusType
- an assessment entry genus type AssessmentEntryList
NullArgumentException
- assessmentEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesByRecordType(Type assessmentEntryRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
containing the given
assessment entry record Type.
In plenary mode, the returned list contains all known
assessments or an error results. Otherwise, the returned list may
contain only those assessments that are accessible through this
session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentEntryRecordType
- an assessment entry record type AssessmentEntryList
listNullArgumentException
-
assessmentEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
effectiveduring the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.from
- starting dateto
- ending date AssessmentEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given student
.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.resourceId
- a resource Id
AssessmentEntryList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given student
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.resourceId
- a resource Id
from
- starting dateto
- ending date AssessmentEntryList
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. AssessmentEntryList getAssessmentEntriesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given assessment.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentId
- an assessment Id
AssessmentEntryList
listNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForAssessmentOnDate(Id assessmentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given assessment
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.assessmentId
- an assessment Id
from
- starting dateto
- ending date AssessmentEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- assessmentId, from
, or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForStudentAndAssessment(Id resourceId, Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given student and
assessment .
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.resourceId
- a resource Id
assessmentId
- an assessment Id
AssessmentEntryList
listNullArgumentException
- resourceId
or
assessmentId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntriesForStudentAndAssessmentOnDate(Id resourceId, Id assessmentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AssessmentEntryList
for the given student and
assessment effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned.resourceId
- a resource Id
assessmentId
- an assessment Id
from
- starting dateto
- ending date AssessmentEntryList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
assessmentId, from
, or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentEntryList getAssessmentEntries() throws OperationFailedException, PermissionDeniedException
AssessmentEntries.
In plenary mode, the returned list contains all known assessments or
an error results. Otherwise, the returned list may contain only those
assessments that are accessible through this session.
In effective mode, assessment entries are returned that are currently
effective. In any effective mode, effective assessment entries and
those currently expired are returned. AssessmentEntries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.