public interface PayerLookupSession extends OsidSession
This session defines methods for retrieving payers.
This lookup session defines several views:
Payers
with the PayerAdminSession.
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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupPayers()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePayerView()
mandatory
- This method is must be implemented. void usePlenaryPayerView()
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.mandatory
- This method is must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. void useEffectivePayerView()
mandatory
- This method is must be implemented. void useAnyEffectivePayerView()
mandatory
- This method is must be implemented. Payer getPayer(Id payerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.payerId
- the Id
of the Payer
to
retrieve Payer
NotFoundException
- no Payer
found with
the given Id
NullArgumentException
- payerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByIds(IdList payerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.payerIds
- the list of Ids
to retrieve PayerList
listNotFoundException
- an Id was
not foundNullArgumentException
- payerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByGenusType(Type payerGenusType) throws OperationFailedException, PermissionDeniedException
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.payerGenusType
- a payer genus type PayerList
listNullArgumentException
- payerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByParentGenusType(Type payerGenusType) throws OperationFailedException, PermissionDeniedException
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.payerGenusType
- a payer genus type PayerList
listNullArgumentException
- payerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByRecordType(Type payerRecordType) throws OperationFailedException, PermissionDeniedException
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.payerRecordType
- a payer record type PayerList
listNullArgumentException
- payerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- starting dateto
- ending date PayerList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
PayerList
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
from
- starting dateto
- ending date PayerList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
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.customerId
- a customer Id
PayerList
listNullArgumentException
- customerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayersByCustomerOnDate(Id customerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.customerId
- a customer Id
from
- starting dateto
- ending date PayerList
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- customerId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerList getPayers() throws OperationFailedException, PermissionDeniedException
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. Payers
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.