Interface | osid.course.registration.ActivityRegistrationAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an 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 | canCreateActivityRegistrations | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ActivityRegistration creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActivityRegistrationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | activityRegistrationRecordTypes | array of activity registration record types |
Return | boolean | true if ActivityRegistration creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | activityRegistrationRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationFormForCreate | ||
Description |
Gets the course form for creating new activity registrations. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | registrationId | the Id for a Registration |
osid.id.Id | activityId | the Id for an Activity | |
osid.id.Id | resourceId | the Id for a Resource | |
osid.type.Type[] | activityRegistrationRecordTypes | array of activity registration record types | |
Return | osid.course.registration.ActivityRegistrationForm | the activity registration form | |
Errors | NOT_FOUND | activityId or resourceId is not found | |
NULL_ARGUMENT | activityId, resourceId, or
activityRegistrationRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested recod types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createActivityRegistration | ||
Description |
Creates a new | ||
Parameters | osid.course.registration.ActivityRegistrationForm | activityRegistrationForm | the form for this ActivityRegistration |
Return | osid.course.registration.ActivityRegistration | the new ActivityRegistration | |
Errors | ILLEGAL_STATE | activityRegistrationForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | activityRegistrationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityRegistrationForm did not originate from
getActivityRegistrationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateActivityRegistrations | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ActivityRegistration modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityRegistrationFormForUpdate | ||
Description |
Gets the activity registration form for updating an existing activity registration. A new activity registration form should be requested for each update transaction. | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration |
Return | osid.course.registration.ActivityRegistrationForm | the activity registration form | |
Errors | NOT_FOUND | activityRegistrationId is not found | |
NULL_ARGUMENT | activityRegistrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateActivityRegistration | ||
Description |
Updates an existing activity registration. | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration |
osid.course.registration.ActivityRegistrationForm | activityRegistrationForm | the form containing the elements to be updated | |
Errors | ILLEGAL_STATE | activityRegistrationForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | activityRegistrationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityRegistrationForm did not originate from
getActivityRegistrationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteActivityRegistrations | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ActivityRegistration deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityRegistration | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration to remove |
Errors | NOT_FOUND | activityRegistrationId not found | |
NULL_ARGUMENT | activityRegistrationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageActivityRegistrationAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ActivityRegistration aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasActivityRegistration | ||
Description |
Adds an | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of an ActivityRegistration |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | activityRegistrationId not found | ||
NULL_ARGUMENT | activityRegistrationId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |