Interface ContactQueryInspector

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

The query inspector for examining contact queries.

  • Method Details

    • getReferenceIdTerms

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

    • getAddresseeIdTerms

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

    • getAddresseeTerms

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

    • getAddressIdTerms

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

    • getAddressTerms

      AddressQueryInspector[] getAddressTerms()
      Gets the address terms.
      Returns:
      the address 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.

    • getContactQueryInspectorRecord

      ContactQueryInspectorRecord getContactQueryInspectorRecord(Type contactRecordType) throws OperationFailedException
      Gets the contact query inspector record corresponding to the given Contact record Type .
      Parameters:
      contactRecordType - a contact record type
      Returns:
      the contact query inspector record
      Throws:
      NullArgumentException - contactRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(contactRecordType) is false
      Compliance:
      mandatory - This method must be implemented.