Interface AddressQueryInspector

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

This is the query inspector for examining address queries. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • getResourceIdTerms

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

    • getResourceTerms

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

    • getAddressTextTerms

      StringTerm[] getAddressTextTerms()
      Gets the address text terms.
      Returns:
      the string terms
      Compliance:
      mandatory - This method must be implemented.

    • getContactIdTerms

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

    • getContactTerms

      ContactQueryInspector[] getContactTerms()
      Gets the contact terms.
      Returns:
      the contact terms
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBookIdTerms

      IdTerm[] getAddressBookIdTerms()
      Gets the address book Id terms.
      Returns:
      the address book Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBookTerms

      AddressBookQueryInspector[] getAddressBookTerms()
      Gets the address book terms.
      Returns:
      the address book terms
      Compliance:
      mandatory - This method must be implemented.

    • getAddressQueryInspectorRecord

      AddressQueryInspectorRecord getAddressQueryInspectorRecord(Type addressRecordType) throws OperationFailedException
      Gets the query inspector record corresponding to the given Address record Type .
      Parameters:
      addressRecordType - an address record type
      Returns:
      the address query inspector record
      Throws:
      NullArgumentException - addressRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(addressRecordType) is false
      Compliance:
      mandatory - This method must be implemented.