Interface ContactQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface ContactQuery extends OsidRelationshipQuery

This is the query for searching contacts. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Like all OsidQueries, ContactQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchReferenceId

      void matchReferenceId(Id referenceId, boolean match)
      Sets a reference Id.
      Parameters:
      referenceId - a reference Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - referenceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearReferenceIdTerms

      void clearReferenceIdTerms()
      Clears the reference Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAddresseeId

      void matchAddresseeId(Id resourceId, boolean match)
      Sets a resource Id.
      Parameters:
      resourceId - a resource Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAddresseeIdTerms

      void clearAddresseeIdTerms()
      Clears the resource Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddresseeQuery

      boolean supportsAddresseeQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAddresseeQuery

      ResourceQuery getAddresseeQuery()
      Gets the query for a resource query. Multiple retrievals produce a nested OR term.
      Returns:
      the resource query
      Throws:
      UnimplementedException - supportsAddresseeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAddresseeQuery()} is {@code true}.

    • clearAddresseeTerms

      void clearAddresseeTerms()
      Clears the resource terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAddressId

      void matchAddressId(Id addressId, boolean match)
      Sets an address Id.
      Parameters:
      addressId - an address Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - addressId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAddressIdTerms

      void clearAddressIdTerms()
      Clears the address Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressQuery

      boolean supportsAddressQuery()
      Tests if an AddressQuery is available.
      Returns:
      true if an address query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAddressQuery

      AddressQuery getAddressQuery()
      Gets the query for an address query. Multiple retrievals produce a nested OR term.
      Returns:
      the address query
      Throws:
      UnimplementedException - supportsAddressQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAddressrQuery()} is {@code true}.

    • clearAddressTerms

      void clearAddressTerms()
      Clears the address terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAddressBookId

      void matchAddressBookId(Id addressBookId, boolean match)
      Sets the address Id for this query to match contacts assigned to address books.
      Parameters:
      addressBookId - an address book Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - addressBookId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAddressBookIdTerms

      void clearAddressBookIdTerms()
      Clears the address book Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookQuery

      boolean supportsAddressBookQuery()
      Tests if an AddressBookQuery is available.
      Returns:
      true if an address book query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBookQuery

      AddressBookQuery getAddressBookQuery()
      Gets the query for an address book query. Multiple retrievals produce a nested OR term.
      Returns:
      the address book query
      Throws:
      UnimplementedException - supportsAddressBookQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAddressBookQuery()} is {@code true}.

    • clearAddressBookTerms

      void clearAddressBookTerms()
      Clears the address book terms.
      Compliance:
      mandatory - This method must be implemented.

    • getContactQueryRecord

      ContactQueryRecord getContactQueryRecord(Type contactRecordType) throws OperationFailedException
      Gets the contact query record corresponding to the given Contact record Type.Multiple record retrievals produce a nested OR term.
      Parameters:
      contactRecordType - a contact record type
      Returns:
      the contact query record
      Throws:
      NullArgumentException - contactRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(contactRecordType) is false
      Compliance:
      mandatory - This method must be implemented.