public interface PaymentSmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PaymentQuery
can be retrieved from this session
and mapped to this CoursOfferingeCatalog
to create a
virtual collection of Payments.
The payments may be
sequenced using the PaymentSearchOrder
from this session.
This Business
has a default query that matches any
payment and a default search order that specifies no sequencing. The
queries may be examined using a PaymentQueryInspector.
The
query may be modified by converting the inspector back to a
PaymentQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPaymentQuery(PaymentQuery paymentQuery)
Applies a payment query to this business.
|
void |
applyPaymentSequencing(PaymentSearchOrder paymentSearchOrder)
Applies a payment search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
PaymentQuery |
getPaymentQuery()
Gets a payment query.
|
PaymentQuery |
getPaymentQueryFromInspector(PaymentQueryInspector paymentQueryInspector)
Gets a payment query from an inspector.
|
PaymentSearchOrder |
getPaymentSearchOrder()
Gets a payment search order.
|
PaymentQueryInspector |
inspectPaymentQuery()
Gets a payment query inspector for this business.
|
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 canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. PaymentQuery getPaymentQuery()
mandatory
- This method must be implemented. PaymentSearchOrder getPaymentSearchOrder()
mandatory
- This method must be implemented. void applyPaymentQuery(PaymentQuery paymentQuery) throws OperationFailedException, PermissionDeniedException
paymentQuery
- the payment queryNullArgumentException
- paymentQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- paymentQuery
not
of this servicemandatory
- This method must be implemented. PaymentQueryInspector inspectPaymentQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPaymentSequencing(PaymentSearchOrder paymentSearchOrder) throws OperationFailedException, PermissionDeniedException
paymentSearchOrder
- the payment search orderNullArgumentException
- paymentSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- paymentSearchOrder
not of this servicemandatory
- This method must be implemented. PaymentQuery getPaymentQueryFromInspector(PaymentQueryInspector paymentQueryInspector)
paymentQueryInspector
- a query inspectorNullArgumentException
- paymentQueryInspector
is null
UnsupportedException
- paymentQueryInspector
is not of this servicemandatory
- This method must be implemented.