OSID - osid.billing.payment.PaymentBusinessAssignmentSession Service Interface Definition

Interface	osid.billing.payment.PaymentBusinessAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.billing.payment.BillingPaymentManager`
Used By	`osid.billing.payment.BillingPaymentProxyManager`
Description	This session provides methods to re-assign `Payments` to `Businesses` . A `Payment` may appear in multiple `Businesses` and removing the last reference to a `Payment` is the equivalent of deleting it. Each `Business` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Payment` to another `Business` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignPayments
Description	Tests if this user can alter payment/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 `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignPaymentToBusiness
Description	Tests if this user can alter payment/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 `PERMISSION_DENIED` . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
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 payment 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`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableBusinessIdsForPayment
Description	Gets a list of businesses including and under the given business node in which a specific payment can be assigned.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment`
Return	`osid.id.IdList`		list of assignable business `Ids`
Errors	NULL_ARGUMENT		`businessId` or `paymentId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignPaymentToBusiness
Description	Adds an existing `Payment` to a `Business` .
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment`
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Errors	ALREADY_EXISTS		`paymentId` is already assigned to `businessId`
	NOT_FOUND		`paymentId` or `businessId` not found
	NULL_ARGUMENT		`paymentId` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignPaymentFromBusiness
Description	Removes a `Payment` from a `Business` .
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment`
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Errors	NOT_FOUND		`paymentId` or `businessId` not found or `paymentId` not assigned to `businessId`
	NULL_ARGUMENT		`paymentId` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignPaymentToBusiness
Description	Moves a `Payment` from one `Business` to another. Mappings to other `Businesses` are unaffected.
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment`
	`osid.id.Id`	`fromBusinessId`	the `Id` of the current `Business`
	`osid.id.Id`	`toBusinessId`	the `Id` of the destination `Business`
Errors	ALREADY_EXISTS		`paymentId` already assigned to `toBusinessId`
	NOT_FOUND		`paymentId, fromBusinessId` , or `toBusinessId` not found or `paymentId` not mapped to `fromBusinessId`
	NULL_ARGUMENT		`paymentId, fromBusinessId` , or `toBusinessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.