Interface CustomerQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidTemporalQueryInspector
public interface CustomerQueryInspector extends OsidObjectQueryInspector, OsidTemporalQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

  • Method Details

    • getResourceIdTerms

      IdTerm[] getResourceIdTerms()
      Gets the resource Id query terms.
      Returns:
      the resource Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getResourceTerms

      ResourceQueryInspector[] getResourceTerms()
      Gets the resource query terms.
      Returns:
      the resource query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerNumberTerms

      StringTerm[] getCustomerNumberTerms()
      Gets the customer number terms.
      Returns:
      the customer number terms
      Compliance:
      mandatory - This method must be implemented.

    • getActivityIdTerms

      IdTerm[] getActivityIdTerms()
      Gets the activity Id query terms.
      Returns:
      the activity Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getActivityTerms

      ActivityQueryInspector[] getActivityTerms()
      Gets the activity query terms.
      Returns:
      the activity query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessIdTerms

      IdTerm[] getBusinessIdTerms()
      Gets the business Id query terms.
      Returns:
      the business Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessTerms

      BusinessQueryInspector[] getBusinessTerms()
      Gets the business query terms.
      Returns:
      the business query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerQueryInspectorRecord

      CustomerQueryInspectorRecord getCustomerQueryInspectorRecord(Type customerRecordType) throws OperationFailedException
      Gets the customer query inspector record corresponding to the given Customer record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      customerRecordType - a customer record type
      Returns:
      the customer query inspector record
      Throws:
      NullArgumentException - customerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(customerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.