Interface | osid.course.ActivityUnitAdminSession | ||
---|---|---|---|
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 | canCreateActivityUnits | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ActivityUnit creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActivityUnitWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | activityUnitRecordTypes | array of activity unit record types |
Return | boolean | true if ActivityUnit creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | activityUnitRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitFormForCreate | ||
Description |
Gets the activity unit form for creating new activity units. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | courseId | the course Id |
osid.type.Type[] | activityUnitRecordTypes | array of activity unit record types | |
Return | osid.course.ActivityUnitForm | the activity unit form | |
Errors | NOT_FOUND | courseId is not found | |
NULL_ARGUMENT | courseId or activityUnitRecordTypes 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 | createActivityUnit | ||
Description |
Creates a new | ||
Parameters | osid.course.ActivityUnitForm | activityUnitForm | the form for this ActivityUnit |
Return | osid.course.ActivityUnit | the new ActivityUnit | |
Errors | ILLEGAL_STATE | activityForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | activityUnitForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityUnitForm did not originate from
getActivityUnitFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateActivityUnits | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ActivityUnit modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitFormForUpdate | ||
Description |
Gets the activity unit form for updating an existing activity unit. A new activity unit form should be requested for each update transaction. | ||
Parameters | osid.id.Id | activityUnitId | the Id of the ActivityUnit |
Return | osid.course.ActivityUnitForm | the activity unit form | |
Errors | NOT_FOUND | activityUnitId is not found | |
NULL_ARGUMENT | activityUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateActivityUnit | ||
Description |
Updates an existing activity unit. | ||
Parameters | osid.course.ActivityUnitForm | activityUnitForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | activityForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | courseForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | activityUnitForm did not originate from
getActivityUnitFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteActivityUnits | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ActivityUnit deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteActivityUnit | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | activityUnitId | the Id of the ActivityUnit to remove |
Errors | NOT_FOUND | activityUnitId not found | |
NULL_ARGUMENT | activityUnitId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageActivityUnitAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ActivityUnit aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasActivityUnit | ||
Description |
Adds an | ||
Parameters | osid.id.Id | activityUnitId | the Id of an ActivityUnit |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | activityUnitId not found | ||
NULL_ARGUMENT | activityUnitId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |