OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileItemSearch
Implementsosid.OsidSearch
Description

ProfileItemSearch defines the interface for specifying profile item search options.

MethodsearchAmongProfileItems
Description

Execute this search among the given list of profile items.

Parametersosid.id.IdListprofileItemIdslist of profile items.
ErrorsNULL_ARGUMENT profileItemIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProfileItemResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileItemSearchOrderprofileItemSearchOrderprofile item search order
ErrorsNULL_ARGUMENT profileItemSearchOrder is null
UNSUPPORTED profileItemSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileItemSearchRecord
Description

Gets the profile item search 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.ProfileItemSearchRecordthe profile item search record
ErrorsNULL_ARGUMENT profileItemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileItemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.