public interface CreditQuerySession extends OsidSession
This session provides methods for querying Credit
objects. The search query is constructed using the CreditQuery.
This session defines views that offer differing behaviors for searching.
Credits may have a query record indicated by their respective record
types. The query record is accessed via the CreditQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCredits()
Tests if this user can perform
Credit searches. |
Billing |
getBilling()
Gets the
Billing associated with this session. |
Id |
getBillingId()
Gets the
Billing Id associated with this
session. |
CreditQuery |
getCreditQuery()
Gets a credit query.
|
CreditList |
getCreditsByQuery(CreditQuery creditQuery)
Gets a list of credits matching the given credit query.
|
void |
useFederatedBillingView()
Federates the view for methods in this session.
|
void |
useIsolatedBillingView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBillingId()
Billing
Id
associated with this
session. Billing Id
associated with this sessionmandatory
- This method must be implemented. Billing getBilling() throws OperationFailedException, PermissionDeniedException
Billing
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCredits()
Credit
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 wish not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBillingView()
mandatory
- This method is must be implemented. void useIsolatedBillingView()
mandatory
- This method is must be implemented. CreditQuery getCreditQuery()
mandatory
- This method must be implemented. CreditList getCreditsByQuery(CreditQuery creditQuery) throws OperationFailedException, PermissionDeniedException
creditQuery
- the credit query CreditList
NullArgumentException
- creditQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- creditQuery
is
not of this servicemandatory
- This method must be implemented.