Interface | osid.course.chronicle.AwardEntryAdminSession | ||
---|---|---|---|
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 | canCreateAwardEntries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if AwardEntry creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAwardEntryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | awardEntryRecordTypes | array of award entry record types |
Return | boolean | true if AwardEntry creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | awardEntryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntryFormForCreate | ||
Description |
Gets the award entry form for creating new award entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | awardId | an award Id |
osid.id.Id | resourceId | a student Id | |
osid.type.Type[] | awardEntryRecordTypes | array of award entry record types | |
Return | osid.course.chronicle.AwardEntryForm | the award entry form | |
Errors | NOT_FOUND | awardId or resourceId is not found | |
NULL_ARGUMENT | awardId, resourceId , or awardEntryRecordTypes
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 | createAwardEntry | ||
Description |
Creates a new | ||
Parameters | osid.course.chronicle.AwardEntryForm | awardEntryForm | the form for this AwardEntry |
Return | osid.course.chronicle.AwardEntry | the new AwardEntry | |
Errors | ILLEGAL_STATE | awardEntryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | awardEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardEntryForm did not originate from
getAwardEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAwardEntries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if AwardEntry modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntryFormForUpdate | ||
Description |
Gets the award entry form for updating an existing award entry. A new award entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry |
Return | osid.course.chronicle.AwardEntryForm | the award entry form | |
Errors | NOT_FOUND | awardEntryId is not found | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAwardEntry | ||
Description |
Updates an existing award entry. | ||
Parameters | osid.course.chronicle.AwardEntryForm | awardEntryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | awardEntryForm already used in an update transaction | |
INVALID_ARGUMENT | awardEntryId is not found | ||
NULL_ARGUMENT | awardEntryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardEntryForm did not originate from
getAwardEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAwardEntries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if AwardEntry deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAwardEntry | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | awardEntryId | the Id of the AwardEntry to remove |
Errors | NOT_FOUND | awardEntryId not found | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAwardEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AwardEntry aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAwardEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | awardEntryId | the Id of an AwardEntry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | awardEntryId not found | ||
NULL_ARGUMENT | awardEntryId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |