OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileItemSearchResults
Implementsosid.OsidSearchResults
Used Byosid.profile.ProfileItemSearchSession
Description

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

MethodgetProfileItems
Description

Gets the profile item list resulting from the search.

Returnosid.profile.ProfileItemList the profile item list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetProfileItemQueryInspector
Description

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

Returnosid.profile.ProfileItemQueryInspector the profile item query inspector
Compliancemandatory This method must be implemented.
MethodgetProfileItemSearchResultsRecord
Description

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

Parametersosid.type.TypeprofileItemSearchRecordType a profile item search record type
Returnosid.profile.records.ProfileItemSearchResultsRecord the profile item search results record
ErrorsNULL_ARGUMENT profileItemSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(profileItemSearchRecordType) is false
Compliancemandatory This method must be implemented.