OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
contact package
Version 3.0.0
Release Candidate Preview
| Interface | osid.contact.ContactQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
The query inspector for examining contact queries. | ||
| Method | getReferenceIdTerms | ||
| Description |
Gets the reference | ||
| Return | osid.search.terms.IdTerm[] | the reference Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddresseeIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddresseeTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource 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 | getAddressBookIdTerms | ||
| Description |
Gets the address book | ||
| Return | osid.search.terms.IdTerm[] | the address book Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressBookTerms | ||
| Description |
Gets the address book terms. | ||
| Return | osid.contact.AddressBookQueryInspector[] | the address book terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactQueryInspectorRecord | ||
| Description |
Gets the contact query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | contactRecordType | a contact record type |
| Return | osid.contact.records.ContactQueryInspectorRecord | the contact query inspector record | |
| Errors | NULL_ARGUMENT | contactRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(contactRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |