Interface | osid.contact.AddressBookQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
Description |
This is the query inspector for examining address book
queries. Each method specifies an | ||
Method | getContactIdTerms | ||
Description |
Gets the contact | ||
Return | osid.search.terms.IdTerm[] | the contact Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactTerms | ||
Description |
Gets the contact terms. | ||
Return | osid.contact.ContactQueryInspector[] | the contact terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressIdTerms | ||
Description |
Gets the address | ||
Return | osid.search.terms.IdTerm[] | the address Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressTerms | ||
Description |
Gets the address terms. | ||
Return | osid.contact.AddressQueryInspector[] | the address terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAddressBookIdTerms | ||
Description |
Gets the ancestor address book | ||
Return | osid.search.terms.IdTerm[] | the ancestor address book Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAddressBookTerms | ||
Description |
Gets the ancestor address book terms. | ||
Return | osid.contact.AddressBookQueryInspector[] | the ancestor address book terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAddressBookIdTerms | ||
Description |
Gets the descendant address book | ||
Return | osid.search.terms.IdTerm[] | the descendant address book Id terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAddressBookTerms | ||
Description |
Gets the descendant address book terms. | ||
Return | osid.contact.AddressBookQueryInspector[] | the descendant address book terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookQueryInspectorRecord | ||
Description |
Gets the query inspector record corresponding to the
given | ||
Parameters | osid.type.Type | addressBookRecordType | an address book record type |
Return | osid.contact.records.AddressBookQueryInspectorRecord | the address book query inspector record | |
Errors | NULL_ARGUMENT | addressBookRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(addressBookRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |