OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
contact package
Version 3.0.0
Release Candidate Preview
| Interface | osid.contact.AddressSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAddresses | ||
| Description |
Gets the address list resulting from a search. | ||
| Return | osid.contact.AddressList | the address list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.contact.AddressQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressSearchResultsRecord | ||
| Description |
Gets the address search results record corresponding to the given address search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | addressSearchRecordType | an address search record type |
| Return | osid.contact.records.AddressSearchResultsRecord | the address search results record | |
| Errors | NULL_ARGUMENT | AddressSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(addressSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |