Interface | osid.assessment.ItemBankAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of an | ||
Method | canAssignItems | ||
Description |
Tests if this user can alter item/bank mappings. A
return of true does not guarantee successful assessment. A
return of false indicates that it is known mapping methods
in this session will result in a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignItemsToBank | ||
Description |
Tests if this user can alter item/bank mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | bankId | the Id of the Bank |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | bankId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBankIds | ||
Description |
Gets a list of banks including and under the given bank node in which any item can be assigned. | ||
Parameters | osid.id.Id | bankId | the Id of the Bank |
Return | osid.id.IdList | list of assignable bank Ids | |
Errors | NULL_ARGUMENT | bankId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBankIdsForItem | ||
Description |
Gets a list of banks including and under the given bank node in which a specific item can be assigned. | ||
Parameters | osid.id.Id | bankId | the Id of the Bank |
osid.id.Id | itemId | the Id of the Item | |
Return | osid.id.IdList | list of assignable bank Ids | |
Errors | NULL_ARGUMENT | bankId or itemId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignItemToBank | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
osid.id.Id | bankId | the Id of the Bank | |
Errors | ALREADY_EXISTS | itemId is already assigned to bankId | |
NOT_FOUND | itemId or bankId not found | ||
NULL_ARGUMENT | itemId or bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignItemFromBank | ||
Description |
Removes an | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
osid.id.Id | bankId | the Id of the Bank | |
Errors | NOT_FOUND | itemId or bankId not found or itemId
not assigned to bankId | |
NULL_ARGUMENT | itemId or bankId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignItemToBilling | ||
Description |
Moves an | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
osid.id.Id | fromBankId | the Id of the current Bank | |
osid.id.Id | toBankId | the Id of the destination Bank | |
Errors | NOT_FOUND | itemId, fromBankId, or toBankId not found or
itemId not mapped to fromBankId | |
NULL_ARGUMENT | itemId, fromBankId, or toBankId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |