OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

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.

MethodgetContactIdTerms
Description

Gets the contact Id terms.

Returnosid.search.terms.IdTerm[]the contact Id terms
CompliancemandatoryThis method must be implemented.
MethodgetContactTerms
Description

Gets the contact terms.

Returnosid.contact.ContactQueryInspector[]the contact terms
CompliancemandatoryThis method must be implemented.
MethodgetAddressIdTerms
Description

Gets the address Id terms.

Returnosid.search.terms.IdTerm[]the address Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAddressTerms
Description

Gets the address terms.

Returnosid.contact.AddressQueryInspector[]the address terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAddressBookIdTerms
Description

Gets the ancestor address book Id terms.

Returnosid.search.terms.IdTerm[]the ancestor address book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAddressBookTerms
Description

Gets the ancestor address book terms.

Returnosid.contact.AddressBookQueryInspector[]the ancestor address book terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAddressBookIdTerms
Description

Gets the descendant address book Id terms.

Returnosid.search.terms.IdTerm[]the descendant address book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAddressBookTerms
Description

Gets the descendant address book terms.

Returnosid.contact.AddressBookQueryInspector[]the descendant address book terms
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookQueryInspectorRecord
Description

Gets the query inspector record corresponding to the given AddressBook record Type.

Parametersosid.type.TypeaddressBookRecordTypean address book record type
Returnosid.contact.records.AddressBookQueryInspectorRecordthe address book query inspector record
ErrorsNULL_ARGUMENT addressBookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressBookRecordType) is false
CompliancemandatoryThis method must be implemented.