| Interface | osid.financials.budgeting.BudgetBusinessAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of a   | ||
| Method | canAssignBudgets | ||
| Description | 
                     Tests if this user can alter budget/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 | canAssignBudgetToBusiness | ||
| Description | 
                     Tests if this user can alter budget/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 budget 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 | getAssignableBusinessIdsForBudget | ||
| Description | 
                     Gets a list of businesses including and under the given business node in which a specific budget can be assigned.  | ||
| Parameters | osid.id.Id | businessId | the  Id  of the  Business   | 
osid.id.Id | budgetId | the  Id  of the  Budget   | |
| Return | osid.id.IdList | list of assignable business  Ids   | |
| Errors | NULL_ARGUMENT |  businessId  or  budgetId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignBudgetToBusiness | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | budgetId | the  Id  of the  Budget   | 
osid.id.Id | businessId | the  Id  of the  Business   | |
| Errors | ALREADY_EXISTS |  budgetId  is already assigned to  businessId   |                 |
| NOT_FOUND |  budgetId  or  businessId  not found  |                 ||
| NULL_ARGUMENT |  budgetId  or  businessId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignBudgetFromBusiness | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | budgetId | the  Id  of the  Budget   | 
osid.id.Id | businessId | the  Id  of the  Business   | |
| Errors | NOT_FOUND |  budgetId  or  businessId  not found or  
budgetId  not assigned to  businessId   |                 |
| NULL_ARGUMENT |  budgetId  or  businessId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignBudgetToBusiness | ||
| Description | 
                     Moves a   | ||
| Parameters | osid.id.Id | budgetId | the  Id  of the  Budget   | 
osid.id.Id | fromBusinessId | the  Id  of the current  Business   | |
osid.id.Id | toBusinessId | the  Id  of the destination  Business   | |
| Errors | NOT_FOUND |  budgetId, fromBusinessId,  or  toBusinessId  not 
found or  budgetId  not mapped to  fromBusinessId   |                 |
| NULL_ARGUMENT |  budgetId, fromBusinessId,  or  toBusinessId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |