OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileEntrySearch
Implementsosid.OsidSearch
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.IdListprofileEntryIdslist of profile entries
ErrorsNULL_ARGUMENT profileEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProfileEntryResults
Description

Specify an ordering to the search results.

Parametersosid.profile.ProfileEntrySearchOrderprofileEntrySearchOrdera profile entry search order
ErrorsNULL_ARGUMENT profileEntrySearchOrder is null
UNSUPPORTED profileEntrySearchOrder is not of this service
CompliancemandatoryThis 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.TypeprofileENtrySearchRecordTypea profile entry search record type
Returnosid.profile.records.ProfileEntrySearchRecordthe profile entry search record
ErrorsNULL_ARGUMENT profileEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(profileEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.