public interface FamilySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search and is used as a vehicle to perform a search within a previous result set.
Modifier and Type | Method and Description |
---|---|
FamilyList |
getFamilies()
Gets the family list resulting from a search.
|
FamilyQueryInspector |
getFamilyQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
FamilySearchResultsRecord |
getFamilySearchResultsRecord(Type familySearchRecordType)
Gets the family search results record corresponding to the given
family search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
FamilyList getFamilies()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. FamilyQueryInspector getFamilyQueryInspector()
mandatory
- This method must be implemented. FamilySearchResultsRecord getFamilySearchResultsRecord(Type familySearchRecordType) throws OperationFailedException, PermissionDeniedException
familySearchRecordType
- a family search record typeNullArgumentException
- FamilySearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(familySearchRecordType)
is false
mandatory
- This method must be implemented.