Interface ProfileSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProfileSearch
extends OsidSearch

The interface for governing profile searches.

Method Summary

Modifier and Type	Method	Description
ProfileSearchRecord	getProfileSearchRecord(Type profileSearchRecordType)	Gets the profile search record corresponding to the given profile search record Type.
void	orderProfileResults(ProfileSearchOrder profileSearchOrder)	Specify an ordering to the search results.
void	searchAmongProfiles(IdList profileIds)	Execute this search among the given list of profiles.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongProfiles

void searchAmongProfiles(IdList profileIds)

Execute this search among the given list of profiles.

Parameters:

profileIds - list of profiles

Throws:

NullArgumentException - profileIds is null

Compliance:

mandatory - This method must be implemented.

orderProfileResults

void orderProfileResults(ProfileSearchOrder profileSearchOrder)

Specify an ordering to the search results.

Parameters:

profileSearchOrder - profile search order

Throws:

NullArgumentException - profileSearchOrder is null

UnsupportedException - profileSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileSearchRecord

ProfileSearchRecord getProfileSearchRecord(Type profileSearchRecordType)
                                    throws OperationFailedException

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.

Parameters:

profileSearchRecordType - a profile search record type

Returns:

the profile search record

Throws:

NullArgumentException - profileSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.