public interface FamilySearch extends OsidSearch
The search interface for governing family searches.
Modifier and Type | Method and Description |
---|---|
FamilySearchRecord |
getFamilySearchRecord(Type familySearchRecordType)
Gets the family search record corresponding to the given family search
record
Type. |
void |
orderFamilyResults(FamilySearchOrder familySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongFamilies(IdList familyIds)
Execute this search among the given list of families.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFamilies(IdList familyIds)
familyIds
- list of familiesNullArgumentException
- familyIds
is
null
mandatory
- This method must be implemented. void orderFamilyResults(FamilySearchOrder familySearchOrder)
familySearchOrder
- family search orderNullArgumentException
- familySearchOrder
is null
UnsupportedException
- familySearchOrder
is not of this servicemandatory
- This method must be implemented. FamilySearchRecord getFamilySearchRecord(Type familySearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object
implementing the requested record.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.