Interface | osid.contact.rules.ContactEnablerQueryInspector | ||
---|---|---|---|
Implements | osid.OsidEnablerQueryInspector | ||
Description |
This is the query inspector for examining contact enabler queries. | ||
Method | getRuledContactIdTerms | ||
Description |
Gets the contact | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledContactTerms | ||
Description |
Gets the contact query terms. | ||
Return | osid.contact.ContactQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookIdTerms | ||
Description |
Gets the address book | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBookTerms | ||
Description |
Gets the address book query terms. | ||
Return | osid.contact.AddressBookQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerQueryInspectorRecord | ||
Description |
Gets the contact enabler query inspector record
corresponding to the given | ||
Parameters | osid.type.Type | contactEnablerRecordType | a contact enabler record type |
Return | osid.contact.rules.records.ContactEnablerQueryInspectorRecord | the contact enabler query inspector record | |
Errors | NULL_ARGUMENT | contactEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(contactEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |