OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileEntrySearch
Implementsosid.OsidSearch
Used Byosid.profile.ProfileEntrySearchSession
Description

ProfileEntrySearch defines the interface for specifying profile entry search options.

MethodsearchAmongProfileEntries
Description

Execute this search among the given list of profile entries.

Parametersosid.id.IdListprofileEntryIds list of profile entries
ErrorsNULL_ARGUMENT profileEntryIds is null
Compliancemandatory This method must be implemented.
MethodorderProfileEntryResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileEntrySearchOrderprofileEntrySearchOrder a profile entry search order
ErrorsNULL_ARGUMENT profileEntrySearchOrder is null
UNSUPPORTED profileEntrySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetProfileEntrySearchRecord
Description

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

Parametersosid.type.TypeprofileEntrySearchRecordType a profile entry search record type
Returnosid.profile.records.ProfileEntrySearchRecord the profile entry search record
ErrorsNULL_ARGUMENT profileEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(profileEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.