Interface CustomerSearchResults

All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
public interface CustomerSearchResults extends OsidSearchResults

This interface provides a means to capture results of a search.

  • Method Details

    • getCustomers

      CustomerList getCustomers()
      Gets the customer list resulting from a search.
      Returns:
      the customer list
      Throws:
      IllegalStateException - the customer list has already been retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerQueryInspector

      CustomerQueryInspector getCustomerQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerSearchResultsRecord

      CustomerSearchResultsRecord getCustomerSearchResultsRecord(Type customerSearchRecordType) throws OperationFailedException
      Gets the customer search results record corresponding to the given customer search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      customerSearchRecordType - a customer search record type
      Returns:
      the customer search results record
      Throws:
      NullArgumentException - customerSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(customerSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.