Interface | osid.checklist.ChecklistAdminSession | ||
---|---|---|---|
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 | canCreateChecklists | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Checklist creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateChecklistWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | checklistRecordTypes | array of checklist record types |
Return | boolean | true if Checklist creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | checklistRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistFormForCreate | ||
Description |
Gets the checklist form for creating new checklists. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | checklistRecordTypes | array of checklist record types |
Return | osid.checklist.ChecklistForm | the checklist form | |
Errors | NULL_ARGUMENT | checklistRecordTypes 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 | createChecklist | ||
Description |
Creates a new | ||
Parameters | osid.checklist.ChecklistForm | checklistForm | the form for this Checklist |
Return | osid.checklist.Checklist | the new Checklist | |
Errors | ILLEGAL_STATE | checklistForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | checklistForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | checklistForm did not originate from
getChecklistFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateChecklists | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Checklist modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistFormForUpdate | ||
Description |
Gets the checklist form for updating an existing checklist. A new checklist form should be requested for each update transaction. | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist |
Return | osid.checklist.ChecklistForm | the checklist form | |
Errors | NOT_FOUND | checklistId is not found | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateChecklist | ||
Description |
Updates an existing checklist. | ||
Parameters | osid.checklist.ChecklistForm | checklistForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | checklistForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | checklistForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | checklistForm did not originate from
getChecklistFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteChecklists | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Checklist deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteChecklist | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | checklistId | the Id of the Checklist to remove |
Errors | NOT_FOUND | checklistId not found | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageChecklistAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Checklist aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasChecklist | ||
Description |
Adds an | ||
Parameters | osid.id.Id | checklistId | the Id of a Checklist |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | checklistId not found | ||
NULL_ARGUMENT | checklistId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |