Interface | osid.course.registration.ActivityRegistrationLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving activity
registrations. An This lookup session defines several views:
The methods Activity 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 | canLookupActivityRegistrations | ||
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 | useComparativeActivityRegistrationView | ||
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 | usePlenaryActivityRegistrationView | ||
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 activity 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 | useEffectiveActivityRegistrationView | ||
Description |
Only activity registrations whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveActivityRegistrationView | ||
Description |
All activity registrations of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActivityRegistration | ||
Description |
Gets the In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration to
retrieve |
Return | osid.course.registration.ActivityRegistration | the returned ActivityRegistration | |
Errors | NOT_FOUND | no ActivityRegistration found with the given Id
| |
NULL_ARGUMENT | activityRegistrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsByIds | ||
Description |
Gets an In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.IdList | activityRegistrationIds | the list of Ids to retrieve |
Return | osid.course.registration.ActivityRegistrationList | the returned ActivityRegistration list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | activityRegistrationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsByGenusType | ||
Description |
Gets an In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | activityRegistrationGenusType | an activity registration genus type |
Return | osid.course.registration.ActivityRegistrationList | the returned ActivityRegistration list | |
Errors | NULL_ARGUMENT | activityRegistrationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsByParentGenusType | ||
Description |
Gets an In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | activityRegistrationGenusType | an activity registration genus type |
Return | osid.course.registration.ActivityRegistrationList | the returned ActivityRegistration list | |
Errors | NULL_ARGUMENT | activityRegistrationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.type.Type | activityRegistrationRecordType | an activity registration record type |
Return | osid.course.registration.ActivityRegistrationList | the returned ActivityRegistration list | |
Errors | NULL_ARGUMENT | activityRegistrationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
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 | getActivityRegistrationsForRegistration | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | registrationId | a registration Id |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForRegistrationOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | registrationId | a registration Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | registrationId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForActivity | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityId | an activity Id |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForActivityOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityId | an activity Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
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 | getActivityRegistrationsForActivityAndStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityId | an activity Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | NULL_ARGUMENT | activityId or resourceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForActivityAndStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | activityId | an activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityId, resourceId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForCourseOffering | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationsForCourseOfferingOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
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 | getActivityRegistrationsForCourseOfferingAndStudent | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
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 | getActivityRegistrationsForCourseOfferingAndStudentOnDate | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity 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.ActivityRegistrationList | a list of ActivityRegistrations | |
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 | getActivityRegistrations | ||
Description |
Gets all In plenary mode, the returned list contains all known activity registrations or an error results. Otherwise, the returned list may contain only those activity registrations that are accessible through this session. In effective mode, activity registrations are returned that are currently effective. In any effective mode, effective activity registrations and those currently expired are returned. | ||
Return | osid.course.registration.ActivityRegistrationList | a list of ActivityRegistrations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |