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

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

MethodgetProfileEntries
Description

Gets the profile entry list resulting from the search.

Returnosid.profile.ProfileEntryListthe profile entry list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryQueryInspector
Description

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

Returnosid.profile.ProfileEntryQueryInspectorthe profile entry query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntrySearchResultsRecord
Description

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

Parametersosid.type.TypeprofileEntrySearchRecordTypea profile entry search record type
Returnosid.profile.records.ProfileEntrySearchResultsRecordthe profile entry search results record
ErrorsNULL_ARGUMENT profileEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.