Interface | osid.course.chronicle.ProgramEntryAdminSession | ||
---|---|---|---|
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 | canCreateProgramEntries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ProgramEntry creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProgramEntryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | programEntryRecordTypes | array of program entry record types |
Return | boolean | true if ProgramEntry creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | programEntryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntryFormForCreate | ||
Description |
Gets the program entry form for creating new program entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | programId | the Id of a Program |
osid.id.Id | resourceId | the Id of a student | |
osid.type.Type[] | programEntryRecordTypes | array of program entry record types | |
Return | osid.course.chronicle.ProgramEntryForm | the program entry form | |
Errors | NOT_FOUND | programId or resourceId is not found | |
NULL_ARGUMENT | programId, resourceId , or programEntryRecordTypes
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 | createProgramEntry | ||
Description |
Creates a new | ||
Parameters | osid.course.chronicle.ProgramEntryForm | programEntryForm | the form for this ProgramEntry |
Return | osid.course.chronicle.ProgramEntry | the new ProgramEntry | |
Errors | ILLEGAL_STATE | programEntryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | programEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programEntryForm did not originate from
getProgramEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProgramEntries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ProgramEntry modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntryFormForUpdate | ||
Description |
Gets the program entry form for updating an existing program entry. A new program entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | programEntryId | the Id of the ProgramEntry |
Return | osid.course.chronicle.ProgramEntryForm | the program entry form | |
Errors | NOT_FOUND | programEntryId is not found | |
NULL_ARGUMENT | programEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProgramEntry | ||
Description |
Updates an existing program entry. | ||
Parameters | osid.course.chronicle.ProgramEntryForm | programEntryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | programEntryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | programEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programEntryForm did not originate from
getProgramEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProgramEntries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ProgramEntry deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProgramEntry | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | programEntryId | the Id of the ProgramEntry |
Return | boolean | false if deletion of this ProgramEntry is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | programEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteProgramEntry | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | programEntryId | the Id of the ProgramEntry to remove |
Errors | NOT_FOUND | programEntryId not found | |
NULL_ARGUMENT | programEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProgramEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ProgramEntry aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProgramEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | programEntryId | the Id of a ProgramEntry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | programEntryId not found | ||
NULL_ARGUMENT | programEntryId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |