OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileItemSearch
Implementsosid.OsidSearch
Used Byosid.profile.ProfileItemSearchSession
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.IdListprofileItemIds list of profile items.
ErrorsNULL_ARGUMENT profileItemIds is null
Compliancemandatory This method must be implemented.
MethodorderProfileItemResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileItemSearchOrderprofileItemSearchOrder profile item search order
ErrorsNULL_ARGUMENT profileItemSearchOrder is null
UNSUPPORTED profileItemSearchOrder is not of this service
Compliancemandatory This 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.TypeprofileItemSearchRecordType a profile item search record type
Returnosid.profile.records.ProfileItemSearchRecord the profile item search record
ErrorsNULL_ARGUMENT profileItemSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(profileItemSearchRecordType) is false
Compliancemandatory This method must be implemented.