OSID Logo
OSID Specifications
contact rules package
Version 3.1.0
Interfaceosid.contact.rules.ContactEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Used Byosid.contact.rules.ContactEnablerSearchResults
osid.contact.rules.ContactEnablerSmartAddressBookSession
Description

This is the query inspector for examining contact enabler queries.

Like all OsidQueryInspectors, ContactEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetRuledContactIdTerms
Description

Gets the contact Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRuledContactTerms
Description

Gets the contact query terms.

Returnosid.contact.ContactQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetAddressBookIdTerms
Description

Gets the address book Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetAddressBookTerms
Description

Gets the address book query terms.

Returnosid.contact.AddressBookQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetContactEnablerQueryInspectorRecord
Description

Gets the contact enabler query inspector record corresponding to the given ContactEnabler record Type.

Parametersosid.type.TypecontactEnablerRecordType a contact enabler record type
Returnosid.contact.rules.records.ContactEnablerQueryInspectorRecord the contact enabler query inspector record
ErrorsNULL_ARGUMENT contactEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(contactEnablerRecordType) is false
Compliancemandatory This method must be implemented.