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

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

MethodgetProfiles
Description

Gets the profile list resulting from the search.

Returnosid.profile.ProfileListthe profile list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProfileQueryInspector
Description

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

Returnosid.profile.ProfileQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProfileSearchResultsRecord
Description

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

Parametersosid.type.TypeprofileSearchRecordTypea profile search record type
Returnosid.profile.records.ProfileSearchResultsRecordthe profile search results record
ErrorsNULL_ARGUMENT profileSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileSearchRecordType) is false
CompliancemandatoryThis method must be implemented.