org.osid.billing.payment

Interface PayerBusinessSession

All Superinterfaces:

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

public interface PayerBusinessSession
extends OsidSession

This session provides methods to retrieve Payer to Business mappings. A Payer may appear in multiple Business objects. 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 Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPayerBusinessMappings() Tests if this user can perform lookups of payer/business mappings.
BusinessList	getBusinessesByPayer(Id payerId) Gets the Business objects mapped to a Payer.
IdList	getBusinessIdsByPayer(Id payerId) Gets the Business Ids mapped to a Payer.
IdList	getPayerIdsByBusiness(Id businessId) Gets the list of Payer Ids associated with a Business.
IdList	getPayerIdsByBusinesses(IdList businessIds) Gets the list of Payer Ids corresponding to a list of Business objects.
PayerList	getPayersByBusiness(Id businessId) Gets the list of Payers associated with a Business.
PayerList	getPayersByBusinesses(IdList businessIds) Gets the list of Payers corresponding to a list of Business objects.
void	useComparativePayerBusinessView() 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	usePlenaryPayerBusinessView() A complete view of the Payer and Business 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

canLookupPayerBusinessMappings

boolean canLookupPayerBusinessMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePayerBusinessView

void useComparativePayerBusinessView()

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.

usePlenaryPayerBusinessView

void usePlenaryPayerBusinessView()

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.

getPayerIdsByBusiness

IdList getPayerIdsByBusiness(Id businessId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the list of Payer Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related payer Ids

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByBusiness

PayerList getPayersByBusiness(Id businessId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the list of Payers associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related payers

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayerIdsByBusinesses

IdList getPayerIdsByBusinesses(IdList businessIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the list of Payer Ids corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of payer Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayersByBusinesses

PayerList getPayersByBusinesses(IdList businessIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets the list of Payers corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of payers

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByPayer

IdList getBusinessIdsByPayer(Id payerId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Business Ids mapped to a Payer.

Parameters:

payerId - Id of a Payer

Returns:

list of business Ids

Throws:

NotFoundException - payerId is not found

NullArgumentException - payerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByPayer

BusinessList getBusinessesByPayer(Id payerId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Business objects mapped to a Payer.

Parameters:

payerId - Id of a Payer

Returns:

list of businesses

Throws:

NotFoundException - payerId is not found

NullArgumentException - payerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.