Interface PersonSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PersonSearch
extends OsidSearch

The search interface for governing person searches.

Method Summary

Modifier and Type	Method	Description
PersonSearchRecord	getPersonSearchRecord(Type personSearchRecordType)	Gets the record corresponding to the given person search record Type .
void	orderPersonResults(PersonSearchOrder personSearchOrder)	Specify an ordering to the search results.
void	searchAmongPersons(IdList personIds)	Execute this search among the given list of persons.

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

searchAmongPersons

void searchAmongPersons(IdList personIds)

Execute this search among the given list of persons.

Parameters:

personIds - list of persons

Throws:

NullArgumentException - personIds is null

Compliance:

mandatory - This method must be implemented.

orderPersonResults

void orderPersonResults(PersonSearchOrder personSearchOrder)

Specify an ordering to the search results.

Parameters:

personSearchOrder - person search order

Throws:

NullArgumentException - personSearchOrder is null

UnsupportedException - personSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPersonSearchRecord

PersonSearchRecord getPersonSearchRecord(Type personSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

personSearchRecordType - a person search record type

Returns:

the person search record

Throws:

NullArgumentException - personSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(personSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.