Interface | osid.course.registration.RegistrationLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving registrations.
A This lookup session defines several views:
The methods Registrations 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 | canLookupRegistrations | ||
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 | useComparativeRegistrationView | ||
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 | usePlenaryRegistrationView | ||
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 registrations 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 | useEffectiveRegistrationView | ||
Description |
Only registrations whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveRegistrationView | ||
Description |
All registrations of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRegistration | ||
Description |
Gets the In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to retrieve |
Return | osid.course.registration.Registration | the returned Registration | |
Errors | NOT_FOUND | no Registration found with the given Id | |
NULL_ARGUMENT | registrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsByIds | ||
Description |
Gets a In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.IdList | registrationIds | the list of Ids to retrieve |
Return | osid.course.registration.RegistrationList | the returned Registration list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | registrationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsByGenusType | ||
Description |
Gets a In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | registrationGenusType | a registration genus type |
Return | osid.course.registration.RegistrationList | the returned Registration list | |
Errors | NULL_ARGUMENT | registrationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsByParentGenusType | ||
Description |
Gets a In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | registrationGenusType | a registration genus type |
Return | osid.course.registration.RegistrationList | the returned Registration list | |
Errors | NULL_ARGUMENT | registrationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | registrationRecordType | a registration record type |
Return | osid.course.registration.RegistrationList | the returned Registration list | |
Errors | NULL_ARGUMENT | registrationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
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 | getRegistrationsForActivityBundle | ||
Description |
Gets all In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. | ||
Parameters | osid.id.Id | activityBundleId | an activity bundle Id |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | NULL_ARGUMENT | activityBundleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForActivityBundleOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityBundleId | an activity bundle Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityBundleId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
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 | getRegistrationsForActivityBundleAndStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityBundleId | an activity bundle Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | NULL_ARGUMENT | activityBundleId or resourceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForActivityBundleAndStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityBundleId | an activity bundle Id |
osid.id.Id | resourceId | a resource Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityBundleId, resourceId, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForCourseOffering | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForCourseOfferingOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | courseOfferingId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForCourseOfferingAndStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | NULL_ARGUMENT | courseOfferingId or resourceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationsForCourseOfferingAndStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
osid.id.Id | resourceId | a resource Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | courseOfferingId, resourceId, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrations | ||
Description |
Gets all In plenary mode, the returned list contains all known registrations or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In effective mode, registrations are returned that are currently effective. In any effective mode, effective registrations and those currently expired are returned. | ||
Return | osid.course.registration.RegistrationList | a list of Registrations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |