| Interface | osid.contact.ContactSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing contact searches. | ||
| Method | searchAmongContacts | ||
| Description |
Execute this search among the given list of contacts. | ||
| Parameters | osid.id.IdList | contactIds | list of contacts |
| Errors | NULL_ARGUMENT | contactIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderContactResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.contact.ContactSearchOrder | contactSearchOrder | contact search order |
| Errors | NULL_ARGUMENT | contactSearchOrder is null | |
| UNSUPPORTED | contactSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactSearchRecord | ||
| Description |
Gets the contact search record corresponding to the
given contact search record | ||
| Parameters | osid.type.Type | contactSearchRecordType | a contact search record type |
| Return | osid.contact.records.ContactSearchRecord | 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. | |