| Interface | osid.contact.rules.ContactEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing contact enabler searches. | ||
| Method | searchAmongContactEnablers | ||
| Description |
Execute this search among the given list of contact enablers. | ||
| Parameters | osid.id.IdList | contactEnablerIds | list of contact enablers |
| Errors | NULL_ARGUMENT | contactEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderContactEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.contact.rules.ContactEnablerSearchOrder | contactEnablerSearchOrder | contact enabler search order |
| Errors | NULL_ARGUMENT | contactEnablerSearchOrder is null | |
| UNSUPPORTED | contactEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactEnablerSearchRecord | ||
| Description |
Gets the contact enabler search record corresponding to
the given contact enabler search record | ||
| Parameters | osid.type.Type | contactEnablerSearchRecordType | a contact enabler search record type |
| Return | osid.contact.rules.records.ContactEnablerSearchRecord | the contact enabler search record | |
| Errors | NULL_ARGUMENT | contactEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(contactEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |