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

Interface	osid.billing.payment.PaymentLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving payments. 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 isolated business view: All payment methods in this session operate, retrieve and pertain to payments defined explicitly in the current business. Using an isolated view is useful for managing `Payments` with the `PaymentAdminSession.` federated business view: All payment lookup methods in this session operate, retrieve and pertain to all payments defined in this business and any other payments implicitly available in this business through business inheritence. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods. Payments may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Payment.`
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPayments
Description	Tests if this user can perform `Payment` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePaymentView
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	usePlenaryPaymentView
Description	A complete view of the `Payment` 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	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include payments in catalogs which are children of this catalog in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPayment
Description	Gets the `Payment` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Payment` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Payment` and retained for compatibility.
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment` to retrieve
Return	`osid.billing.payment.Payment`		the returned `Payment`
Errors	NOT_FOUND		no `Payment` found with the given `Id`
	NULL_ARGUMENT		`paymentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByIds
Description	Gets a `PaymentList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the payments specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Payments` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`paymentIds`	the list of `Ids` to retrieve
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`paymentIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByGenusType
Description	Gets a `PaymentList` corresponding to the given payment genus `Type` which does not include payments of types derived from the specified `Type.` In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.type.Type`	`paymentGenusType`	a payment genus type
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`paymentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByParentGenusType
Description	Gets a `PaymentList` corresponding to the given payment genus `Type` and include any additional payments with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.type.Type`	`paymentGenusType`	a payment genus type
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`paymentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByRecordType
Description	Gets a `PaymentList` containing the given payment record `Type.` In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.type.Type`	`paymentRecordType`	a payment record type
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`paymentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByPeriod
Description	Gets a `PaymentList` in the given period. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForPayer
Description	Gets a `PaymentList` for the given payer. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByPeriodForPayer
Description	Gets a `PaymentList` for the given payer in a billing period. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
Parameters	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`payerId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForPayerOnDate
Description	Gets a `PaymentList` for the given payer made within the given date range inclusive. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`payerId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForCustomer
Description	Gets a `PaymentList` for the given customer. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByPeriodForCustomer
Description	Gets a `PaymentList` for the given customer and billing period. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`customerId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForCustomerOnDate
Description	Gets a `PaymentList` for the given customer made within the given date range inclusive. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForPayerAndCustomer
Description	Gets a `PaymentList` for the given payer and customer. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
Parameters	`osid.id.Id`	`customerId`	a customerId `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`payerId` or `customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsByPeriodForPayerAndCustomer
Description	Gets a `PaymentList` for the given payer and customer in a billing period. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
	`osid.id.Id`	`customerId`	a customerId `Id`
	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	NULL_ARGUMENT		`payerId, customerId,` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentsForPayerAndCustomerOnDate
Description	Gets a `PaymentList` for the given customer and payer made within the given date range inclusive. In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
	`osid.id.Id`	`customerId`	a customerId `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.payment.PaymentList`		the returned `Payment` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`payerId, customerId,` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayments
Description	Gets all `Payments.` In plenary mode, the returned list contains all known payments or an error results. Otherwise, the returned list may contain only those payments that are accessible through this session.
Return	`osid.billing.payment.PaymentList`		a list of `Payments`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.