OSID Logo
OSID Specifications
contact rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.rules.ContactEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetContactEnablers
Description

Gets the ContactEnablerList resulting from a search.

Returnosid.contact.rules.ContactEnablerListthe contact enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.contact.rules.ContactEnablerQueryInspectorthe contact enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerSearchResultsRecord
Description

Gets the contact enabler search results record corresponding to the given contact enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypecontactEnablerSearchRecordTypea contact enabler search record type
Returnosid.contact.rules.records.ContactEnablerSearchResultsRecordthe contact enabler search results record
ErrorsNULL_ARGUMENT contactEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(contactEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.