| Interface | osid.billing.CategoryBusinessAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignCategories | ||
| Description |
Tests if this user can alter category/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 | canAssignCategoryToBusiness | ||
| Description |
Tests if this user can alter category/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 category 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 | getAssignableBusinessIdsForCategory | ||
| Description |
Gets a list of businesses including and under the given business node in which a specific category can be assigned. | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.id.Id | categoryId | the Id of the Category | |
| Return | osid.id.IdList | list of assignable business Ids | |
| Errors | NULL_ARGUMENT | businessId or categoryId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignCategoryToBusiness | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | categoryId | the Id of the Category |
osid.id.Id | businessId | the Id of the Business | |
| Errors | ALREADY_EXISTS | categoryId is already assigned to businessId | |
| NOT_FOUND | categoryId or businessId not found | ||
| NULL_ARGUMENT | categoryId or businessId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignCategoryFromBusiness | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | categoryId | the Id of the Category |
osid.id.Id | businessId | the Id of the Business | |
| Errors | NOT_FOUND | categoryId or businessId not found or
categoryId not assigned to businessId | |
| NULL_ARGUMENT | categoryId or businessId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignCategoryToBusiness | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | categoryId | the Id of the Category |
osid.id.Id | fromBusinessId | the Id of the current Business | |
osid.id.Id | toBusinessId | the Id of the destination Business | |
| Errors | NOT_FOUND | categoryId, fromBusinessId, or toBusinessId
not found or categoryId not mapped to fromBusinessId
| |
| NULL_ARGUMENT | categoryId, fromBusinessId, or toBusinessId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |