Interface | osid.learning.ObjectiveBankAdminSession | ||
---|---|---|---|
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 | canCreateObjectiveBanks | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ObjectiveBank creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateObjectiveBankWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | objectiveBankRecordTypes | array of objective bank record types |
Return | boolean | true if ObjectiveBank creation using the
specified Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | objectiveBankRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBankFormForCreate | ||
Description |
Gets the objective bank form for creating new objective banks. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | objectiveBankRecordTypes | array of objective bank record types |
Return | osid.learning.ObjectiveBankForm | the objective bank form | |
Errors | NULL_ARGUMENT | objectiveBankRecordTypes 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 | createObjectiveBank | ||
Description |
Creates a new | ||
Parameters | osid.learning.ObjectiveBankForm | objectiveBankForm | the form for this ObjectiveBank |
Return | osid.learning.ObjectiveBank | the new ObjectiveBank | |
Errors | ILLEGAL_STATE | objectiveBankForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | objectiveBankForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | objectiveBankForm did not originate from
getObjectiveBankFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateObjectiveBanks | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ObjectiveBank modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBankFormForUpdate | ||
Description |
Gets the objective bank form for updating an existing objective bank. A new objective bank form should be requested for each update transaction. | ||
Parameters | osid.id.Id | objectiveBankId | the Id of the ObjectiveBank |
Return | osid.learning.ObjectiveBankForm | the objective bank form | |
Errors | NOT_FOUND | objectiveBankId is not found | |
NULL_ARGUMENT | objectiveBankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateObjectiveBank | ||
Description |
Updates an existing objective bank. | ||
Parameters | osid.learning.ObjectiveBankForm | objectiveBankForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | objectiveBankForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | objectiveBankForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | objectiveBankForm did not originate from
getObjectiveBankFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteObjectiveBanks | ||
Description |
Tests if this user can delete objective banks. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting an
| ||
Return | boolean | false if ObjectiveBank deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteObjectiveBank | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | objectiveBankId | the Id of the ObjectiveBank to remove |
Errors | NOT_FOUND | objectiveBankId not found | |
NULL_ARGUMENT | objectiveBankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageObjectiveBankAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ObjectiveBank aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasObjectiveBank | ||
Description |
Adds an | ||
Parameters | osid.id.Id | objectiveBankId | the Id of an ObjectiveBank |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | objectiveBankId not found | ||
NULL_ARGUMENT | objectiveBankId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |