Interface AccountQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface AccountQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector

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

    • getCreditBalanceTerms

      BooleanTerm[] getCreditBalanceTerms()
      Gets the credit balance query terms.
      Returns:
      the credit balance query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCodeTerms

      StringTerm[] getCodeTerms()
      Gets the code query terms.
      Returns:
      the code query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSummaryTerms

      SummaryQueryInspector[] getSummaryTerms()
      Gets the summary query terms.
      Returns:
      the summary query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorAccountIdTerms

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

    • getAncestorAccountTerms

      AccountQueryInspector[] getAncestorAccountTerms()
      Gets the ancestor account query terms.
      Returns:
      the ancestor account terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantAccountIdTerms

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

    • getDescendantAccountTerms

      AccountQueryInspector[] getDescendantAccountTerms()
      Gets the descendant account query terms.
      Returns:
      the descendant account 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.

    • getAccountQueryInspectorRecord

      AccountQueryInspectorRecord getAccountQueryInspectorRecord(Type accountRecordType) throws OperationFailedException
      Gets the account query inspector record corresponding to the given Account record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      accountRecordType - an account record type
      Returns:
      the account query inspector record
      Throws:
      NullArgumentException - accountRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(accountRecordType) is false
      Compliance:
      mandatory - This method must be implemented.