Interface | osid.course.chronicle.AwardEntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving entriesand entry components. This lookup session defines several views:
The methods AwardEntries 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 | canLookupAwardEntries | ||
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 | useComparativeAwardEntryView | ||
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 | usePlenaryAwardEntryView | ||
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 awards 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 | useEffectiveAwardEntryView | ||
Description |
Only award entries whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveAwardEntryView | ||
Description |
All award entries of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAwardEntry | ||
Description |
Gets the In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry to retrieve |
Return | osid.course.chronicle.AwardEntry | the returned chronicle | |
Errors | NOT_FOUND | no AwardEntry found with the given Id | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesByIds | ||
Description |
Gets an In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.IdList | awardEntryId | the list of Ids to retrieve |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesByGenusType | ||
Description |
Gets an In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.type.Type | awardEntryGenusType | an award entry genus type |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList | |
Errors | NULL_ARGUMENT | awardEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesByParentGenusType | ||
Description |
Gets an In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.type.Type | awardEntryGenusType | an award entry genus type |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList | |
Errors | NULL_ARGUMENT | awardEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.type.Type | awardEntryRecordType | an award entry record type |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList list | |
Errors | NULL_ARGUMENT | awardEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList 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 | getAwardEntriesForStudent | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList 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 | getAwardEntriesForStudentOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award 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.AwardEntryList | the returned AwardEntryList 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 | getAwardEntriesForAward | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | awardId | an award Id |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList list | |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesForAwardOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | awardId | an award Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | awardId, from , or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesForStudentAndAward | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | awardId | an award Id | |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList list | |
Errors | NULL_ARGUMENT | resourceId or awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntriesForStudentAndAwardOnDate | ||
Description |
Gets an In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | awardId | an award Id | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.course.chronicle.AwardEntryList | the returned AwardEntryList list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, awardId, from , or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntries | ||
Description |
Gets all In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned. | ||
Return | osid.course.chronicle.AwardEntryList | a list of AwardEntries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |