OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileSearchResults
Implementsosid.OsidSearchResults
Used Byosid.profile.ProfileSearchSession
Description

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

MethodgetProfiles
Description

Gets the profile list resulting from the search.

Returnosid.profile.ProfileList the profile list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetProfileQueryInspector
Description

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

Returnosid.profile.ProfileQueryInspector the query inspector
Compliancemandatory This 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.TypeprofileSearchRecordType a profile search record type
Returnosid.profile.records.ProfileSearchResultsRecord the profile search results record
ErrorsNULL_ARGUMENT profileSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(profileSearchRecordType) is false
Compliancemandatory This method must be implemented.