public interface PaymentBusinessSession extends OsidSession
This session provides methods to retrieve Payment
to
Business
mappings. A Payment
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPaymentBusinessMappings()
Tests if this user can perform lookups of payment/business mappings.
|
BusinessList |
getBusinessesByPayment(Id paymentId)
Gets the
Business objects mapped to a Payment. |
IdList |
getBusinessIdsByPayment(Id paymentId)
Gets the
Business Ids mapped to a
Payment. |
IdList |
getPaymentIdsByBusiness(Id businessId)
Gets the list of
Payment Ids associated with a
Business. |
IdList |
getPaymentIdsByBusinesses(IdList businessIds)
Gets the list of
Payment Ids corresponding to a list of
Business objects. |
PaymentList |
getPaymentsByBusiness(Id businessId)
Gets the list of
Payments associated with a
Business. |
PaymentList |
getPaymentsByBusinesses(IdList businessIds)
Gets the list of
Payments corresponding to a list of
Business objects. |
void |
useComparativePaymentBusinessView()
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 |
usePlenaryPaymentBusinessView()
A complete view of the
Payment and Business
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPaymentBusinessMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePaymentBusinessView()
mandatory
- This method is must be implemented. void usePlenaryPaymentBusinessView()
Payment
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.mandatory
- This method is must be implemented. IdList getPaymentIdsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Payment Ids
associated with a
Business.
businessId
- Id
of the Business
Ids
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Payments
associated with a
Business.
businessId
- Id
of the Business
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPaymentIdsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Payment Ids
corresponding to a list of
Business
objects.businessIds
- list of business Ids
Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PaymentList getPaymentsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Payments
corresponding to a list of
Business
objects.businessIds
- list of business Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBusinessIdsByPayment(Id paymentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
Ids
mapped to a
Payment.
paymentId
- Id
of a Payment
NotFoundException
- paymentId
is not
foundNullArgumentException
- paymentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessList getBusinessesByPayment(Id paymentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
objects mapped to a Payment.
paymentId
- Id
of a Payment
NotFoundException
- paymentId
is not
foundNullArgumentException
- paymentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.