Interface CreditQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CreditSearchSession
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.

  • federated billing view: searches include credits in billings of which this billing is a ancestor in the billing hierarchy
  • isolated billing view: searches are restricted to credits in this billing

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.

  • Method Details

    • getBillingId

      Id getBillingId()
      Gets the Billing Id associated with this session.
      Returns:
      the Billing Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBilling

      Billing getBilling() throws OperationFailedException, PermissionDeniedException
      Gets the Billing associated with this session.
      Returns:
      the billing
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchCredits

      boolean canSearchCredits()
      Tests if this user can perform 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.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedBillingView

      void useFederatedBillingView()
      Federates the view for methods in this session. A federated view will include credits in billings which are children of this billing in the billing hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBillingView

      void useIsolatedBillingView()
      Isolates the view for methods in this session. An isolated view restricts searches to this billing only.
      Compliance:
      mandatory - This method is must be implemented.

    • getCreditQuery

      CreditQuery getCreditQuery()
      Gets a credit query.
      Returns:
      the credit query
      Compliance:
      mandatory - This method must be implemented.

    • getCreditsByQuery

      CreditList getCreditsByQuery(CreditQuery creditQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of credits matching the given credit query.
      Parameters:
      creditQuery - the credit query
      Returns:
      the returned CreditList
      Throws:
      NullArgumentException - creditQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - creditQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.