Interface | osid.course.program.ProgramOfferingAdminSession | ||
---|---|---|---|
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 | canCreateProgramOfferings | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ProgramOffering creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProgramOfferingWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | programOfferingRecordTypes | array of program offering record types |
Return | boolean | true if ProgramOffering creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | programOfferingRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingFormForCreate | ||
Description |
Gets the program offering form for creating new program offerings. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | programId | the Id of the associated Program |
osid.id.Id | termId | the Id of the associated Term | |
osid.type.Type[] | programOfferingRecordTypes | array of program offering record types | |
Return | osid.course.program.ProgramOfferingForm | the program offering form | |
Errors | NOT_FOUND | programId or termId not found | |
NULL_ARGUMENT | programId, termId or programOfferingRecordTypes
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 | createProgramOffering | ||
Description |
Creates a new | ||
Parameters | osid.course.program.ProgramOfferingForm | programOfferingForm | the form for this ProgramOffering |
Return | osid.course.program.ProgramOffering | the new ProgramOffering | |
Errors | ILLEGAL_STATE | programOfferingForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | programOfferingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programOfferingForm did not originate from
getProramOfferingFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProgramOfferings | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ProgramOffering modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingFormForUpdate | ||
Description |
Gets the program offering form for updating an existing program offering. A new program offering form should be requested for each update transaction. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering |
Return | osid.course.program.ProgramOfferingForm | the program offering form | |
Errors | NOT_FOUND | programOfferingId is not found | |
NULL_ARGUMENT | programOfferingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProgramOffering | ||
Description |
Updates an existing program offering. | ||
Parameters | osid.course.program.ProgramOfferingForm | programOfferingForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | programOfferingForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | programOfferingForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programOfferingForm did not originate from
getProramOfferingFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProgramOfferings | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ProgramOffering deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProgramOffering | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to remove |
Errors | NOT_FOUND | programOfferingId not found | |
NULL_ARGUMENT | programOfferingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProgramOfferingAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ProgramOffering aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProgramOffering | ||
Description |
Adds an | ||
Parameters | osid.id.Id | programOfferingId | the Id of a ProgramOffering |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | programOfferingId not found | ||
NULL_ARGUMENT | programOfferingId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |