Interface | osid.financials.AccountBusinessAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignAccounts | ||
Description |
Tests if this user can alter account/business 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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignAccountToBusiness | ||
Description |
Tests if this user can alter account/business 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 | businessId | the Id of the Business |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | businessId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBusinessIds | ||
Description |
Gets a list of businesses including and under the given business node in which any account can be assigned. | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
Return | osid.id.IdList | list of assignable business Ids | |
Errors | NULL_ARGUMENT | businessId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableBusinessIdsForAccount | ||
Description |
Gets a list of businesses including and under the given business node in which a specific account can be assigned. | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.id.Id | accountId | the Id of the Account | |
Return | osid.id.IdList | list of assignable business Ids | |
Errors | NULL_ARGUMENT | businessId or accountId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignAccountToBusiness | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | accountId | the Id of the Account |
osid.id.Id | businessId | the Id of the Business | |
Errors | ALREADY_EXISTS | accountId is already assigned to businessId | |
NOT_FOUND | accountId or businessId not found | ||
NULL_ARGUMENT | accountId or businessId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAccountFromBusiness | ||
Description |
Removes an | ||
Parameters | osid.id.Id | accountId | the Id of the Account |
osid.id.Id | businessId | the Id of the Business | |
Errors | NOT_FOUND | accountId or businessId not found or
accountId not assigned to businessId | |
NULL_ARGUMENT | accountId or businessId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |