OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetProfileEntryEnablers
Description

Gets the ProfileEntryEnablerList resulting from a search.

Returnosid.profile.rules.ProfileEntryEnablerListthe profile entry enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerQueryInspector
Description

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

Returnosid.profile.rules.ProfileEntryEnablerQueryInspectorthe profile entry enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeprofileEntryEnablerSearchRecordTypea profile entry enabler search record type
Returnosid.profile.rules.records.ProfileEntryEnablerSearchResultsRecordthe profile entry enabler search results record
ErrorsNULL_ARGUMENT profileEntryEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(profileEntryEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.