OSID Logo
OSID Specifications
profile package
Version 3.1.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.IdListprofileIds list of profiles
ErrorsNULL_ARGUMENT profileIds is null
Compliancemandatory This method must be implemented.
MethodorderProfileResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileSearchOrderprofileSearchOrder profile search order
ErrorsNULL_ARGUMENT profileSearchOrder is null
UNSUPPORTED profileSearchOrder is not of this service
Compliancemandatory This 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.TypeprofileSearchRecordType a profile search record type
Returnosid.profile.records.ProfileSearchRecord the profile search record
ErrorsNULL_ARGUMENT profileSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(profileSearchRecordType) is false
Compliancemandatory This method must be implemented.