Interface | osid.course.registration.RegistrationAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateRegistrations | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Registration creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRegistrationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | registrationRecordTypes | array of registration record types |
Return | boolean | true if Registration creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | registrationRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationFormForCreate | ||
Description |
Gets the registration form for creating new registrations. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | activityBundleId | the Id of the activity bundle |
osid.id.Id | resourceId | the Id of the student | |
osid.type.Type[] | registrationRecordTypes | array of registration record types | |
Return | osid.course.registration.RegistrationForm | the registration form | |
Errors | NOT_FOUND | activityBundleId or resourceId not found | |
NULL_ARGUMENT | activityBundleId, resourceId, or
registrationRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRegistration | ||
Description |
Creates a new | ||
Parameters | osid.course.registration.RegistrationForm | registrationForm | the form for this Registration |
Return | osid.course.registration.Registration | the new Registration | |
Errors | ILLEGAL_STATE | registrationForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | registrationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | registrationForm did not originate from
getRegistrationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRegistrations | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Registration modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationFormForUpdate | ||
Description |
Gets the registration form for updating an existing registration. A new registration form should be requested for each update transaction. | ||
Parameters | osid.id.Id | registrationId | the Id of the Registration |
Return | osid.course.registration.RegistrationForm | the registration form | |
Errors | NOT_FOUND | registrationId is not found | |
NULL_ARGUMENT | registrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRegistration | ||
Description |
Updates an existing registration. | ||
Parameters | osid.course.registration.RegistrationForm | registrationForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | registrationForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | registrationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | registrationForm did not originate from
getRegistrationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRegistrations | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Registration deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRegistration | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to remove |
Errors | NOT_FOUND | registrationId not found | |
NULL_ARGUMENT | registrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRegistrationAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Registration aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRegistration | ||
Description |
Adds an | ||
Parameters | osid.id.Id | registrationId | the Id of a Registration |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | registrationId not found | ||
NULL_ARGUMENT | registrationId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |