org.osid.billing.payment

Interface PayerLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PayerLookupSession
extends OsidSession

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 Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPayers() Tests if this user can perform Payer lookups.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
Payer	getPayer(Id payerId) Gets the Payer specified by its Id.
PayerList	getPayers() Gets all Payers.
PayerList	getPayersByCustomer(Id customerId) Gets a PayerList related to the given payer customer.
PayerList	getPayersByCustomerOnDate(Id customerId, DateTime from, DateTime to) Gets a PayerList of the given customer and effective during the entire given date range inclusive but not confined to the date range.
PayerList	getPayersByGenusType(Type payerGenusType) Gets a PayerList corresponding to the given payer genus Type which does not include payers of types derived from the specified Type.
PayerList	getPayersByIds(IdList payerIds) Gets a PayerList corresponding to the given IdList.
PayerList	getPayersByParentGenusType(Type payerGenusType) Gets a PayerList corresponding to the given payer genus Type and include any additional payers with genus types derived from the specified Type.
PayerList	getPayersByRecordType(Type payerRecordType) Gets a PayerList containing the given payer record Type.
PayerList	getPayersByResource(Id resourceId) Gets a PayerList related to the given resource .
PayerList	getPayersByResourceOnDate(Id resourceId, DateTime from, DateTime to) Gets a PayerList of the given resource and effective during the entire given date range inclusive but not confined to the date range.
PayerList	getPayersOnDate(DateTime from, DateTime to) Gets a PayerList effective during the entire given date range inclusive but not confined to the date range.
void	useAnyEffectivePayerView() All payers of any effective dates are returned by methods in this session.
void	useComparativePayerView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useEffectivePayerView() Only payers whose effective dates are current are returned by methods in this session.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.
void	usePlenaryPayerView() A complete view of the Payer returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupPayers

boolean canLookupPayers()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePayerView

void useComparativePayerView()

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.

usePlenaryPayerView

void usePlenaryPayerView()

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.

useFederatedBusinessView

void useFederatedBusinessView()

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.

useIsolatedBusinessView

void useIsolatedBusinessView()

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.

useEffectivePayerView

void useEffectivePayerView()

Only payers whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectivePayerView

void useAnyEffectivePayerView()

All payers of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getPayer

Payer getPayer(Id payerId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

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:

payerId - the Id of the Payer to retrieve

Returns:

the returned Payer

Throws:

NotFoundException - no Payer found with the given Id

NullArgumentException - payerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByIds

PayerList getPayersByIds(IdList payerIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

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:

payerIds - the list of Ids to retrieve

Returns:

the returned PayerList list

Throws:

NotFoundException - an Id was not found

NullArgumentException - payerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByGenusType

PayerList getPayersByGenusType(Type payerGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

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:

payerGenusType - a payer genus type

Returns:

the returned PayerList list

Throws:

NullArgumentException - payerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByParentGenusType

PayerList getPayersByParentGenusType(Type payerGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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:

payerGenusType - a payer genus type

Returns:

the returned PayerList list

Throws:

NullArgumentException - payerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByRecordType

PayerList getPayersByRecordType(Type payerRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

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:

payerRecordType - a payer record type

Returns:

the returned PayerList list

Throws:

NullArgumentException - payerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersOnDate

PayerList getPayersOnDate(DateTime from,
                        DateTime to)
                          throws OperationFailedException,
                                 PermissionDeniedException

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:

from - starting date

to - ending date

Returns:

the returned PayerList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByResource

PayerList getPayersByResource(Id resourceId)
                              throws OperationFailedException,
                                     PermissionDeniedException

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:

resourceId - a resource Id

Returns:

the returned PayerList list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByResourceOnDate

PayerList getPayersByResourceOnDate(Id resourceId,
                                  DateTime from,
                                  DateTime to)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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:

resourceId - a resource Id

from - starting date

to - ending date

Returns:

the returned PayerList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByCustomer

PayerList getPayersByCustomer(Id customerId)
                              throws OperationFailedException,
                                     PermissionDeniedException

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:

customerId - a customer Id

Returns:

the returned PayerList list

Throws:

NullArgumentException - customerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByCustomerOnDate

PayerList getPayersByCustomerOnDate(Id customerId,
                                  DateTime from,
                                  DateTime to)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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:

customerId - a customer Id

from - starting date

to - ending date

Returns:

the returned PayerList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - customerId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayers

PayerList getPayers()
                    throws OperationFailedException,
                           PermissionDeniedException

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.

Returns:

a list of Payers

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.