OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileItemSearchResults
Implementsosid.OsidSearchResults
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.ProfileItemListthe profile item list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemQueryInspector
Description

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

Returnosid.profile.ProfileItemQueryInspectorthe profile item query inspector
CompliancemandatoryThis 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.TypeprofileItemSearchRecordTypea profile item search record type
Returnosid.profile.records.ProfileItemSearchResultsRecordthe profile item search results record
ErrorsNULL_ARGUMENT profileItemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileItemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.