Interface FamilySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FamilySearch
extends OsidSearch

The search interface for governing family searches.

Method Summary

Modifier and Type	Method	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.

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

searchAmongFamilies

void searchAmongFamilies(IdList familyIds)

Execute this search among the given list of families.

Parameters:

familyIds - list of families

Throws:

NullArgumentException - familyIds is null

Compliance:

mandatory - This method must be implemented.

orderFamilyResults

void orderFamilyResults(FamilySearchOrder familySearchOrder)

Specify an ordering to the search results.

Parameters:

familySearchOrder - family search order

Throws:

NullArgumentException - familySearchOrder is null

UnsupportedException - familySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFamilySearchRecord

FamilySearchRecord getFamilySearchRecord(Type familySearchRecordType)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

familySearchRecordType - a family search record type

Returns:

the family search record

Throws:

NullArgumentException - familySearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(familySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.