| Interface | osid.financials.posting.PostBusinessAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignPosts | ||
| Description |
Tests if this user can alter post/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 | canAssignPostToBusiness | ||
| Description |
Tests if this user can alter post/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 post 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 | getAssignableBusinessIdsForPost | ||
| Description |
Gets a list of businesses including and under the given business node in which a specific post can be assigned. | ||
| Parameters | osid.id.Id | businessId | the Id of the Business |
osid.id.Id | postId | the Id of the Post | |
| Return | osid.id.IdList | list of assignable business Ids | |
| Errors | NULL_ARGUMENT | businessId or postId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignPostToBusiness | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | postId | the Id of the Post |
osid.id.Id | businessId | the Id of the Business | |
| Errors | ALREADY_EXISTS | postId is already assigned to businessId | |
| NOT_FOUND | postId or businessId not found | ||
| NULL_ARGUMENT | postId or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignPostFromBusiness | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | postId | the Id of the Post |
osid.id.Id | businessId | the Id of the Business | |
| Errors | NOT_FOUND | postId or businessId not found or
postId not assigned to businessId | |
| NULL_ARGUMENT | postId or businessId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |