Interface AddressBookQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface AddressBookQueryInspector extends OsidCatalogQueryInspector

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

  • Method Details

    • 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.

    • 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.

    • getAncestorAddressBookIdTerms

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

    • getAncestorAddressBookTerms

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

    • getDescendantAddressBookIdTerms

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

    • getDescendantAddressBookTerms

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

    • getAddressBookQueryInspectorRecord

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