Interface PayerBusinessSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PayerBusinessSession
extends OsidSession

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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.