org.osid.billing.payment

Interface PayerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

PayerSearchSession

public interface PayerQuerySession
extends OsidSession

This session provides methods for searching among Payer objects. The search query is constructed using the PayerQuery.

This session defines views that offer differing behaviors for searching.

• federated business view: searches include payers in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to payers in this business

Payers may have a query record indicated by their respective record types. The query record is accessed via the PayerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchPayers() Tests if this user can perform Payer searches.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
PayerQuery	getPayerQuery() Gets a payer query.
PayerList	getPayersByQuery(PayerQuery payerQuery) Gets a list of Payers matching the given payer query.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.

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.

canSearchPayers

boolean canSearchPayers()

Tests if this user can perform Payer searches. 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 opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include payers in business which are children of this business 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 lookups to this business only.

Compliance:

mandatory - This method is must be implemented.

getPayerQuery

PayerQuery getPayerQuery()

Gets a payer query.

Returns:

the payer query

Compliance:

mandatory - This method must be implemented.

getPayersByQuery

PayerList getPayersByQuery(PayerQuery payerQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Payers matching the given payer query.

Parameters:

payerQuery - the payer query

Returns:

the returned PayerList

Throws:

NullArgumentException - payerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - payerQuery is not of this service

Compliance:

mandatory - This method must be implemented.