public interface PaymentLookupSession extends OsidSession
This session defines methods for retrieving payments.
This lookup session defines several views:
Payments
with the PaymentAdminSession.
The methods useFederatedBusinessView()
and
useIsolatedBusinessView()
behave as a radio group and one should
be selected before invoking any lookup methods.
Payments may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Payment.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPayments()
Tests if this user can perform
Payment lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
Payment |
getPayment(Id paymentId)
Gets the
Payment specified by its Id. |
PaymentList |
getPayments()
Gets all
Payments. |
PaymentList |
getPaymentsByGenusType(Type paymentGenusType)
Gets a
PaymentList corresponding to the given payment
genus Type which does not include payments of types
derived from the specified Type. |
PaymentList |
getPaymentsByIds(IdList paymentIds)
Gets a
PaymentList corresponding to the given
IdList. |
PaymentList |
getPaymentsByParentGenusType(Type paymentGenusType)
Gets a
PaymentList corresponding to the given payment
genus Type and include any additional payments with
genus types derived from the specified Type. |
PaymentList |
getPaymentsByPeriod(Id periodId)
Gets a
PaymentList in the given period. |
PaymentList |
getPaymentsByPeriodForCustomer(Id customerId,
Id periodId)
Gets a
PaymentList for the given customer and billing
period. |
PaymentList |
getPaymentsByPeriodForPayer(Id payerId,
Id periodId)
Gets a
PaymentList for the given payer in a billing
period. |
PaymentList |
getPaymentsByPeriodForPayerAndCustomer(Id payerId,
Id customerId,
Id periodId)
Gets a
PaymentList for the given payer and customer in
a billing period. |
PaymentList |
getPaymentsByRecordType(Type paymentRecordType)
Gets a
PaymentList containing the given payment record
Type. |
PaymentList |
getPaymentsForCustomer(Id customerId)
Gets a
PaymentList for the given customer. |
PaymentList |
getPaymentsForCustomerOnDate(Id customerId,
DateTime from,
DateTime to)
Gets a
PaymentList for the given customer made within
the given date range inclusive. |
PaymentList |
getPaymentsForPayer(Id payerId)
Gets a
PaymentList for the given payer. |
PaymentList |
getPaymentsForPayerAndCustomer(Id payerId,
Id customerId)
Gets a
PaymentList for the given payer and customer. |
PaymentList |
getPaymentsForPayerAndCustomerOnDate(Id payerId,
Id customerId,
DateTime from,
DateTime to)
Gets a
PaymentList for the given customer and payer
made within the given date range inclusive. |
PaymentList |
getPaymentsForPayerOnDate(Id payerId,
DateTime from,
DateTime to)
Gets a
PaymentList for the given payer made within the
given date range inclusive. |
void |
useComparativePaymentView()
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 |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
void |
usePlenaryPaymentView()
A complete view of the
Payment 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 canLookupPayments()
Payment
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 useComparativePaymentView()
mandatory
- This method is must be implemented. void usePlenaryPaymentView()
Payment
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. Payment getPayment(Id paymentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Payment
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Payment
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Payment
and retained for compatibility.paymentId
- the Id
of the Payment
to retrieve Payment
NotFoundException
- no Payment
found
with the given Id
NullArgumentException
- paymentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByIds(IdList paymentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PaymentList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
payments 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 Payments
may be omitted from the list and
may present the elements in any order including returning a unique
set.paymentIds
- the list of Ids
to retrieve Payment
listNotFoundException
- an Id was
not foundNullArgumentException
- paymentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByGenusType(Type paymentGenusType) throws OperationFailedException, PermissionDeniedException
PaymentList
corresponding to the given payment
genus Type
which does not include payments of types
derived from the specified Type.
In plenary mode, the
returned list contains all known payments or an error results.
Otherwise, the returned list may contain only those payments that are
accessible through this session.paymentGenusType
- a payment genus type Payment
listNullArgumentException
- paymentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByParentGenusType(Type paymentGenusType) throws OperationFailedException, PermissionDeniedException
PaymentList
corresponding to the given payment
genus Type
and include any additional payments with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known payments or an error
results. Otherwise, the returned list may contain only those payments
that are accessible through this session.paymentGenusType
- a payment genus type Payment
listNullArgumentException
- paymentGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByRecordType(Type paymentRecordType) throws OperationFailedException, PermissionDeniedException
PaymentList
containing the given payment record
Type.
In plenary mode, the returned list contains all
known payments or an error results. Otherwise, the returned list may
contain only those payments that are accessible through this session.paymentRecordType
- a payment record type Payment
listNullArgumentException
- paymentRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByPeriod(Id periodId) throws OperationFailedException, PermissionDeniedException
PaymentList
in the given period. In plenary
mode, the returned list contains all known payments or an error
results. Otherwise, the returned list may contain only those payments
that are accessible through this session.periodId
- a period Id
Payment
listNullArgumentException
- periodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given payer. In plenary
mode, the returned list contains all known payments or an error
results. Otherwise, the returned list may contain only those payments
that are accessible through this session.payerId
- a payer Id
Payment
listNullArgumentException
- payerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByPeriodForPayer(Id payerId, Id periodId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given payer in a billing
period. In plenary mode, the returned list contains all known payments
or an error results. Otherwise, the returned list may contain only
those payments that are accessible through this session.payerId
- a payer Id
periodId
- a period Id
Payment
listNullArgumentException
- payerId
or
periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForPayerOnDate(Id payerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given payer made within the
given date range inclusive. In plenary mode, the returned list
contains all known payments or an error results. Otherwise, the
returned list may contain only those payments that are accessible
through this session.payerId
- a payer Id
from
- start of date rangeto
- end of date range Payment
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- payerId
or
periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given customer. In plenary
mode, the returned list contains all known payments or an error
results. Otherwise, the returned list may contain only those payments
that are accessible through this session.customerId
- a customer Id
Payment
listNullArgumentException
- customerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByPeriodForCustomer(Id customerId, Id periodId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given customer and billing
period. In plenary mode, the returned list contains all known payments
or an error results. Otherwise, the returned list may contain only
those payments that are accessible through this session.customerId
- a customer Id
periodId
- a period Id
Payment
listNullArgumentException
- customerId
or
periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForCustomerOnDate(Id customerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given customer made within
the given date range inclusive. In plenary mode, the returned list
contains all known payments or an error results. Otherwise, the
returned list may contain only those payments that are accessible
through this session.customerId
- a customer Id
from
- start of date rangeto
- end of date range Payment
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- customerId
or
periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForPayerAndCustomer(Id payerId, Id customerId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given payer and customer. In
plenary mode, the returned list contains all known payments or an
error results. Otherwise, the returned list may contain only those
payments that are accessible through this session.payerId
- a payer Id
customerId
- a customerId Id
Payment
listNullArgumentException
- payerId
or
customerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByPeriodForPayerAndCustomer(Id payerId, Id customerId, Id periodId) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given payer and customer in
a billing period. In plenary mode, the returned list contains all
known payments or an error results. Otherwise, the returned list may
contain only those payments that are accessible through this session.payerId
- a payer Id
customerId
- a customerId Id
periodId
- a period Id
Payment
listNullArgumentException
- payerId, customerId,
or periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsForPayerAndCustomerOnDate(Id payerId, Id customerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PaymentList
for the given customer and payer
made within the given date range inclusive. In plenary mode, the
returned list contains all known payments or an error results.
Otherwise, the returned list may contain only those payments that are
accessible through this session.payerId
- a payer Id
customerId
- a customerId Id
from
- start of date rangeto
- end of date range Payment
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- payerId, customerId,
or periodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPayments() throws OperationFailedException, PermissionDeniedException
Payments.
In plenary mode, the returned list
contains all known payments or an error results. Otherwise, the
returned list may contain only those payments that are accessible
through this session. Payments
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.