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

Interface	osid.billing.payment.BillingPaymentManager
Implements	`osid.OsidManager`
Implements	`osid.billing.payment.BillingPaymentProfile`
Description	The billing manager provides access to payer management sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `PayerLookupSession:` a session to retrieve payers `PayerQuerySession:` a session to query payers `PayerSearchSession:` a session to search for payers `PayerAdminSession:` a session to create and delete payers `PayerNotificationSession:` a session to receive notifications pertaining to payer changes `PayerBusinessSession:` a session to look up payer to business mappings `PayerBusinessAssignmentSession:` a session to manage payer to business mappings `PayerSmartBusinessSession:` a session to manage dynamic businesses of payers `PaymentLookupSession:` a session to retrieve payments `PaymentQuerySession:` a session to query payments `PaymentSearchSession:` a session to search for payments `PaymentAdminSession:` a session to create and delete payments `PaymentNotificationSession:` a session to receive notifications pertaining to payment changes `PaymentBusinessSession:` a session to look up payment to business mappings `PaymentBusinessAssignmentSession:` a session to manage payment to business mappings `PaymentSmartBusinessSession:` a session to manage dynamic businesses of payments SummarySession: a session to look up account summaries
Method	getPayerLookupSession
Description	Gets the `OsidSession` associated with the payer lookup service.
Return	`osid.billing.payment.PayerLookupSession`		a `PayerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerLookup()` is `true.`
Method	getPayerLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the payer lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the business
Return	`osid.billing.payment.PayerLookupSession`		a `PayerLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerLookup()` and `supportsVisibleFederation()` are `true`
Method	getPayerQuerySession
Description	Gets the `OsidSession` associated with the payer query service.
Return	`osid.billing.payment.PayerQuerySession`		a `PayerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerQuery()` is `true.`
Method	getPayerQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the payer query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerQuerySession`		a `PayerQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerQuery()` and `supportsVisibleFederation()` are `true`
Method	getPayerSearchSession
Description	Gets the `OsidSession` associated with the payer search service.
Return	`osid.billing.payment.PayerSearchSession`		a `PayerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerSearch()` is `true.`
Method	getPayerSearchSessionForBusiness
Description	Gets the `OsidSession` associated with the payer search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerSearchSession`		a `PayerSearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerSearch()` and `supportsVisibleFederation()` are `true`
Method	getPayerAdminSession
Description	Gets the `OsidSession` associated with the payer administration service.
Return	`osid.billing.payment.PayerAdminSession`		a `PayerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerAdmin()` is `true.`
Method	getPayerAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the payer administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerAdminSession`		a `PayerAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPayerNotificationSession
Description	Gets the `OsidSession` associated with the payer notification service.
Parameters	`osid.billing.payment.PayerReceiver`	`payerReceiver`	the notification callback
Return	`osid.billing.payment.PayerNotificationSession`		a `PayerNotificationSession`
Errors	NULL_ARGUMENT		`payerReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerNotification()` is `true.`
Method	getPayerNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the payer notification service for the given business.
Parameters	`osid.billing.payment.PayerReceiver`	`payerReceiver`	the notification callback
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerNotificationSession`		a `PayerNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`payerReceiver` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerNotification()` and `supportsVisibleFederation()` are `true`
Method	getPayerBusinessSession
Description	Gets the `OsidSession` to lookup payer/catalog mappings.
Return	`osid.billing.payment.PayerBusinessSession`		a `PayerPayerBusinessSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerBusiness()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerBusiness()` is `true.`
Method	getPayerBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning payers to businesses.
Return	`osid.billing.payment.PayerBusinessAssignmentSession`		a `PayerBusinessAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPayerBusinessAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerBusinessAssignment()` is `true.`
Method	getPayerSmartBusinessSession
Description	Gets the `OsidSession` associated with the payer smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerSmartBusinessSession`		a `PayerSmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPayerSmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerSmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getPaymentLookupSession
Description	Gets the `OsidSession` associated with the payment lookup service.
Return	`osid.billing.payment.PaymentLookupSession`		a `PaymentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentLookup()` is `true.`
Method	getPaymentLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the payment lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the business
Return	`osid.billing.payment.PaymentLookupSession`		a `PaymentLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentLookup()` and `supportsVisibleFederation()` are `true`
Method	getPaymentQuerySession
Description	Gets the `OsidSession` associated with the payment query service.
Return	`osid.billing.payment.PayerQuerySession`		a `PaymentQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentQuery()` is `true.`
Method	getPaymentQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the payment query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PayerQuerySession`		a `PaymentQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentQuery()` and `supportsVisibleFederation()` are `true`
Method	getPaymentSearchSession
Description	Gets the `OsidSession` associated with the payment search service.
Return	`osid.billing.payment.PaymentSearchSession`		a `PaymentSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentSearch()` is `true.`
Method	getPaymentSearchSessionForBusiness
Description	Gets the `OsidSession` associated with the payment search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PaymentSearchSession`		a `PaymentSearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentSearch()` and `supportsVisibleFederation()` are `true`
Method	getPaymentAdminSession
Description	Gets the `OsidSession` associated with the payment administration service.
Return	`osid.billing.payment.PaymentAdminSession`		a `PaymentAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentAdmin()` is `true.`
Method	getPaymentAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the payment administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PaymentAdminSession`		a `PaymentAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPaymentNotificationSession
Description	Gets the `OsidSession` associated with the payment notification service.
Parameters	`osid.billing.payment.PaymentReceiver`	`paymentReceiver`	the notification callback
Return	`osid.billing.payment.PaymentNotificationSession`		a `PaymentNotificationSession`
Errors	NULL_ARGUMENT		`paymentReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentNotification()` is `true.`
Method	getPaymentNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the payment notification service for the given business.
Parameters	`osid.billing.payment.PaymentReceiver`	`paymentReceiver`	the notification callback
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PaymentNotificationSession`		a `PaymentNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`paymentReceiver` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentNotification()` and `supportsVisibleFederation()` are `true`
Method	getPaymentBusinessSession
Description	Gets the `OsidSession` to lookup payment/catalog mappings.
Return	`osid.billing.payment.PaymentBusinessSession`		a `PaymentBusinessSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentBusiness()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentBusiness()` is `true.`
Method	getPaymentBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning payments to businesses.
Return	`osid.billing.payment.PaymentBusinessAssignmentSession`		a `PaymentBusinessAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPaymentBusinessAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentBusinessAssignment()` is `true.`
Method	getPaymentSmartBusinessSession
Description	Gets the `OsidSession` associated with the payment smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.PaymentSmartBusinessSession`		a `PaymentSmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPaymentSmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPaymentSmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getSummarySession
Description	Gets the `OsidSession` associated with the payment summary service.
Return	`osid.billing.payment.SummarySession`		a `SummarySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSummary()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSummary()` is `true.`
Method	getSummarySessionForBusiness
Description	Gets the `OsidSession` associated with the summary service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.billing.payment.SummarySession`		a `SummarySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSummary()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSummary()` and `supportsVisibleFederation()` are `true`
Method	getBillingPaymentBatchManager
Description	Gets a `BillingPaymentBatchManager.`
Return	`osid.billing.payment.batch.BillingPaymentBatchManager`		a `BillingPaymentBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBillingPaymentBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingPaymentBatch()` is `true.`