public interface PersonSearch extends OsidSearch
The search interface for governing person searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPersons(IdList personIds)
personIds
- list of personsNullArgumentException
- personIds
is
null
mandatory
- This method must be implemented. void orderPersonResults(PersonSearchOrder personSearchOrder)
personSearchOrder
- person search orderNullArgumentException
- personSearchOrder
is null
UnsupportedException
- personSearchOrder
is not of this servicemandatory
- This method must be implemented. PersonSearchRecord getPersonSearchRecord(Type personSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.personSearchRecordType
- a person search record typeNullArgumentException
- personSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(personSearchRecordType)
is false
mandatory
- This method must be implemented.