Interface | osid.contact.rules.ContactEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getContactEnablers | ||
Description |
Gets the | ||
Return | osid.contact.rules.ContactEnablerList | the contact enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.contact.rules.ContactEnablerQueryInspector | the contact enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerSearchResultsRecord | ||
Description |
Gets the contact enabler search results 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.ContactEnablerSearchResultsRecord | the contact enabler search results record | |
Errors | NULL_ARGUMENT | contactEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(contactEnablerSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |