Interface | osid.assessment.BankAdminSession | ||
---|---|---|---|
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 | canCreateBanks | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Bank creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBankWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | bankRecordTypes | array of bank record types |
Return | boolean | true if Bank creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | bankRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankFormForCreate | ||
Description |
Gets the bank form for creating new banks. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | bankRecordTypes | array of bank record types to be included in the create operation or an empty list if none |
Return | osid.assessment.BankForm | the bank form | |
Errors | NULL_ARGUMENT | bankRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBank | ||
Description |
Creates a new | ||
Parameters | osid.assessment.BankForm | bankForm | the form for this Bank |
Return | osid.assessment.Bank | the new Bank | |
Errors | ILLEGAL_STATE | bankForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | bankForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | bankForm did not originate from
getBankFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBanks | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Bank modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankFormForUpdate | ||
Description |
Gets the bank form for updating an existing bank. A new bank form should be requested for each update transaction. | ||
Parameters | osid.id.Id | bankId | the Id of the Bank |
Return | osid.assessment.BankForm | the bank form | |
Errors | NOT_FOUND | bankId is not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBank | ||
Description |
Updates an existing bank. | ||
Parameters | osid.assessment.BankForm | bankForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | bankForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | bankForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | bankForm did not originate from
getBankFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBanks | ||
Description |
Tests if this user can delete banks. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting a | ||
Return | boolean | false if Bank deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBank | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | bankId | the Id of the Bank to remove |
Errors | NOT_FOUND | bankId not found | |
NULL_ARGUMENT | bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBankAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Bank aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBank | ||
Description |
Adds an | ||
Parameters | osid.id.Id | bankId | the Id of a Bank |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | bankId not found | ||
NULL_ARGUMENT | bankId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |