Interface CreditSearchSession

All Superinterfaces:
AutoCloseable, Closeable, CreditQuerySession, OsidSession, OsidSession
public interface CreditSearchSession extends CreditQuerySession

This session provides methods for searching Credit objects. The search query is constructed using the CreditQuery. The credit record Type also specifies the record for the credit query.

getCreditsByQuery() is the basic search method and returns a list of Credit elements. A more advanced search may be performed with getCreditsBySearch(). It accepts a CreditSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCreditsBySearch() returns a CreditSearchResults that can be used to access the resulting CreditList or be used to perform a search within the result set through CreditSearch.

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.

Like all OsidSessions, CreditSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getCreditSearch

      CreditSearch getCreditSearch()
      Gets a credit search.
      Returns:
      the credit search
      Compliance:
      mandatory - This method must be implemented.

    • getCreditSearchOrder

      CreditSearchOrder getCreditSearchOrder()
      Gets a credit search order. The CreditSearchOrder is supplied to a CreditSearch to specify the ordering of results.
      Returns:
      the credit search order
      Compliance:
      mandatory - This method must be implemented.

    • getCreditsBySearch

      CreditSearchResults getCreditsBySearch(CreditQuery creditQuery, CreditSearch creditSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search.
      Parameters:
      creditQuery - the credit query
      creditSearch - the credit search
      Returns:
      the search results
      Throws:
      NullArgumentException - creditQuery or creditSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - creditQuery or creditSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCreditQueryFromInspector

      CreditQuery getCreditQueryFromInspector(CreditQueryInspector creditQueryInspector)
      Gets a credit query from an inspector. The inspector is available from a CreditSearchResults.
      Parameters:
      creditQueryInspector - a credit query inspector
      Returns:
      the credit query
      Throws:
      NullArgumentException - creditQueryInspector is null
      UnsupportedException - creditQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.