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