public interface PersonSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PersonQueryInspector |
getPersonQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
PersonList |
getPersons()
Gets the person list resulting from a search.
|
PersonSearchResultsRecord |
getPersonSearchResultsRecord(Type personSearchRecordType)
Gets the record corresponding to the given person search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PersonList getPersons()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. PersonQueryInspector getPersonQueryInspector()
mandatory
- This method must be implemented. PersonSearchResultsRecord getPersonSearchResultsRecord(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.