OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
contact package
Version 3.0.0
Release Candidate Preview
| Interface | osid.contact.AddressQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining address queries.
Each method specifies an | ||
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressTextTerms | ||
| Description |
Gets the address text terms. | ||
| Return | osid.search.terms.StringTerm[] | the string terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | 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 | getAddressQueryInspectorRecord | ||
| Description |
Gets the query inspector record corresponding to the
given | ||
| Parameters | osid.type.Type | addressRecordType | an address record type |
| Return | osid.contact.records.AddressQueryInspectorRecord | the address query inspector record | |
| Errors | NULL_ARGUMENT | addressRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(addressRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |