OSID Logo
OSID Specifications
profile package
Version 3.0.0
Interfaceosid.profile.ProfileSearch
Implementsosid.OsidSearch
Used Byosid.profile.ProfileSearchSession
Description

The interface for governing profile searches.

MethodsearchAmongProfiles
Description

Execute this search among the given list of profiles.

Parametersosid.id.IdListprofileIdslist of profiles
ErrorsNULL_ARGUMENTprofileIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProfileResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileSearchOrderprofileSearchOrderprofile search order
ErrorsNULL_ARGUMENTprofileSearchOrder is null
UNSUPPORTEDprofileSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProfileSearchRecord
Description

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

Parametersosid.type.TypeprofileSearchRecordTypea profile search record type
Returnosid.profile.records.ProfileSearchRecordthe profile search record
ErrorsNULL_ARGUMENTprofileSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(profileSearchRecordType) is false
CompliancemandatoryThis method must be implemented.