Interface | osid.course.chronicle.AssessmentEntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving entriesand entry components. This lookup session defines several views:
The methods AssessmentEntries may have an additional records indicated
by their respective record types. The record may not be
accessed through a cast of the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupAssessmentEntries | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeAssessmentEntryView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryAssessmentEntryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include assessments in catalogs which are children of this catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveAssessmentEntryView | ||
Description |
Only assessment entries whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveAssessmentEntryView | ||
Description |
All assessment entries of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAssessmentEntry | ||
Description |
Gets the In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned. | ||
Parameters | osid.id.Id | assessmentEntryId | the Id of the AssessmentEntry to retrieve |
Return | osid.course.chronicle.AssessmentEntry | the returned chronicle | |
Errors | NOT_FOUND | no AssessmentEntry found with the given Id | |
NULL_ARGUMENT | assessmentEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesByIds | ||
Description |
Gets an In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned. | ||
Parameters | osid.id.IdList | assessmentEntryId | the list of Ids to retrieve |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | assessmentEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesByGenusType | ||
Description |
Gets an In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned. | ||
Parameters | osid.type.Type | assessmentEntryGenusType | an assessment entry genus type |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList | |
Errors | NULL_ARGUMENT | assessmentEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesByParentGenusType | ||
Description |
Gets an In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned. | ||
Parameters | osid.type.Type | assessmentEntryGenusType | an assessment entry genus type |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList | |
Errors | NULL_ARGUMENT | assessmentEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesByRecordType | ||
Description |
Gets an In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned. | ||
Parameters | osid.type.Type | assessmentEntryRecordType | an assessment entry record type |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | NULL_ARGUMENT | assessmentEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesOnDate | ||
Description |
Gets an 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. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForStudent | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForStudentOnDate | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from , or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForAssessment | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | NULL_ARGUMENT | assessmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForAssessmentOnDate | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | assessmentId, from , or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForStudentAndAssessment | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | assessmentId | an assessment Id | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | NULL_ARGUMENT | resourceId or assessmentId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntriesForStudentAndAssessmentOnDate | ||
Description |
Gets an 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. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | assessmentId | an assessment Id | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AssessmentEntryList | the returned AssessmentEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, assessmentId, from , or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentEntries | ||
Description |
Gets all 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. | ||
Return | osid.course.chronicle.AssessmentEntryList | a list of AssessmentEntries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |