| Interface | osid.contact.ContactSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getContacts | ||
| Description |
Gets the contact list resulting from a search. | ||
| Return | osid.contact.ContactList | the contact list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.contact.ContactQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactSearchResultsRecord | ||
| Description |
Gets the contact search results record corresponding to
the given contact search record | ||
| Parameters | osid.type.Type | contactSearchRecordType | a contact search record type |
| Return | osid.contact.records.ContactSearchResultsRecord | the contact search record | |
| Errors | NULL_ARGUMENT | contactSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(contactSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |