org.osid.profile

Interface ProfileEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProfileEntrySearch
extends OsidSearch

ProfileEntrySearch defines the interface for specifying profile entry search options.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileEntrySearchRecord	getProfileEntrySearchRecord(Type profileENtrySearchRecordType) Gets the profile entry record corresponding to the given profile entry search record Type.
void	orderProfileEntryResults(ProfileEntrySearchOrder profileEntrySearchOrder) Specify an ordering to the search results.
void	searchAmongProfileEntries(IdList profileEntryIds) Execute this search among the given list of profile entries.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongProfileEntries

void searchAmongProfileEntries(IdList profileEntryIds)

Execute this search among the given list of profile entries.

Parameters:

profileEntryIds - list of profile entries

Throws:

NullArgumentException - profileEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderProfileEntryResults

void orderProfileEntryResults(ProfileEntrySearchOrder profileEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

profileEntrySearchOrder - a profile entry search order

Throws:

NullArgumentException - profileEntrySearchOrder is null

UnsupportedException - profileEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileEntrySearchRecord

ProfileEntrySearchRecord getProfileEntrySearchRecord(Type profileENtrySearchRecordType)
                                                     throws OperationFailedException

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.

Parameters:

profileENtrySearchRecordType - a profile entry search record type

Returns:

the profile entry search record

Throws:

NullArgumentException - profileEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.