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

Interface	osid.billing.payment.PayerLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving payers. 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 payer methods in this session operate, retrieve and pertain to payers defined explicitly in the current business. Using an isolated view is useful for managing `Payers` with the `PayerAdminSession.` federated business view: All payer lookup methods in this session operate, retrieve and pertain to all payers defined in this business and any other payers implicitly available in this business through business inheritence. effective payer view: All payer lookup methods return payers where the current date falls in between the effective dates inclusive. any effective payer view: Payers of any effective date are returned from methods. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods. Payers may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Payer.`
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	canLookupPayers
Description	Tests if this user can perform `Payer` 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	useComparativePayerView
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	usePlenaryPayerView
Description	A complete view of the `Payer` 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 payers 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	useEffectivePayerView
Description	Only payers whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectivePayerView
Description	All payers of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getPayer
Description	Gets the `Payer` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Payer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Payer` and retained for compatibility. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.Id`	`payerId`	the `Id` of the `Payer` to retrieve
Return	`osid.billing.payment.Payer`		the returned `Payer`
Errors	NOT_FOUND		no `Payer` found with the given `Id`
	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByIds
Description	Gets a `PayerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the payers 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 `Payers` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.IdList`	`payerIds`	the list of `Ids` to retrieve
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`payerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByGenusType
Description	Gets a `PayerList` corresponding to the given payer genus `Type` which does not include payers of types derived from the specified `Type.` In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.type.Type`	`payerGenusType`	a payer genus type
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	NULL_ARGUMENT		`payerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByParentGenusType
Description	Gets a `PayerList` corresponding to the given payer genus `Type` and include any additional payers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.type.Type`	`payerGenusType`	a payer genus type
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	NULL_ARGUMENT		`payerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByRecordType
Description	Gets a `PayerList` containing the given payer record `Type.` In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.type.Type`	`payerRecordType`	a payer record type
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	NULL_ARGUMENT		`payerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersOnDate
Description	Gets a `PayerList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByResource
Description	Gets a `PayerList` related to the given resource `.` In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByResourceOnDate
Description	Gets a `PayerList` of the given resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayersByCustomer
Description	Gets a `PayerList` related to the given payer customer. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Return	`osid.billing.payment.PayerList`		the returned `PayerList` 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	getPayersByCustomerOnDate
Description	Gets a `PayerList` of the given customer and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session. In effective mode, payers are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective payers and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.billing.payment.PayerList`		the returned `PayerList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPayers
Description	Gets all `Payers.` In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those payers that are accessible through this session.
Return	`osid.billing.payment.PayerList`		a list of `Payers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.