Interface ProfileItemSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProfileItemSearch
extends OsidSearch

ProfileItemSearch defines the interface for specifying profile item search options.

Method Summary

Modifier and Type	Method	Description
ProfileItemSearchRecord	getProfileItemSearchRecord(Type profileItemSearchRecordType)	Gets the profile item search record corresponding to the given profile item search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProfileItemResults(ProfileItemSearchOrder profileItemSearchOrder)	Specify an ordering to the search results.
void	searchAmongProfileItems(IdList profileItemIds)	Execute this search among the given list of profile items.

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

searchAmongProfileItems

void searchAmongProfileItems(IdList profileItemIds)

Execute this search among the given list of profile items.

Parameters:

profileItemIds - list of profile items.

Throws:

NullArgumentException - profileItemIds is null

Compliance:

mandatory - This method must be implemented.

orderProfileItemResults

void orderProfileItemResults(ProfileItemSearchOrder profileItemSearchOrder)

Specify an ordering to the search results.

Parameters:

profileItemSearchOrder - profile item search order

Throws:

NullArgumentException - profileItemSearchOrder is null

UnsupportedException - profileItemSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProfileItemSearchRecord

ProfileItemSearchRecord getProfileItemSearchRecord(Type profileItemSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

profileItemSearchRecordType - a profile item search record type

Returns:

the profile item search record

Throws:

NullArgumentException - profileItemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.