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