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

Interface	osid.billing.payment.PayerBusinessSession
Implements	`osid.OsidSession`
Used By	`osid.billing.payment.BillingPaymentManager`
Used By	`osid.billing.payment.BillingPaymentProxyManager`
Description	This session provides methods to retrieve `Payer` to `Business` mappings. A `Payer` may appear in multiple `Businesses` . Each catalog may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupPayerBusinessMappings
Description	Tests if this user can perform lookups of payer/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePayerBusinessView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryPayerBusinessView
Description	A complete view of the `Payer` and `Business` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getPayerIdsByBusiness
Description	Gets the list of `Payer Ids` associated with a `Business` .
Parameters	`osid.id.Id`	`businessId`	`Id` of the `Business`
Return	`osid.id.IdList`		list of related payer `Ids`
Errors	NOT_FOUND		`businessId` is not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByBusiness
Description	Gets the list of `Payers` associated with a `Business` .
Parameters	`osid.id.Id`	`businessId`	`Id` of the `Business`
Return	`osid.billing.payment.PayerList`		list of related payers
Errors	NOT_FOUND		`businessId` is not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayerIdsByBusinesses
Description	Gets the list of `Payer Ids` corresponding to a list of `Business` objects.
Parameters	`osid.id.IdList`	`businessIds`	list of business `Ids`
Return	`osid.id.IdList`		list of payer `Ids`
Errors	NULL_ARGUMENT		`businessIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByBusinesses
Description	Gets the list of `Payers` corresponding to a list of `Business` objects.
Parameters	`osid.id.IdList`	`businessIds`	list of business `Ids`
Return	`osid.billing.payment.PayerList`		list of payers
Errors	NULL_ARGUMENT		`businessIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessIdsByPayer
Description	Gets the `Business` `Ids` mapped to a `Payer` .
Parameters	`osid.id.Id`	`payerId`	`Id` of a `Payer`
Return	`osid.id.IdList`		list of business `Ids`
Errors	NOT_FOUND		`payerId` is not found
	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessesByPayer
Description	Gets the `Business` objects mapped to a `Payer` .
Parameters	`osid.id.Id`	`payerId`	`Id` of a `Payer`
Return	`osid.billing.BusinessList`		list of businesses
Errors	NOT_FOUND		`payerId` is not found
	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.