OSID - osid.relationship.FamilySearch Service Interface Definition

Interface	osid.relationship.FamilySearch
Implements	`osid.OsidSearch`
Used By	`osid.relationship.FamilySearchSession`
Description	The search interface for governing family searches.
Method	searchAmongFamilies
Description	Execute this search among the given list of families.
Parameters	`osid.id.IdList`	`familyIds`	list of families
Errors	NULL_ARGUMENT		`familyIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderFamilyResults
Description	Specify an ordering to the search results.
Parameters	`osid.relationship.FamilySearchOrder`	`familySearchOrder`	family search order
Errors	NULL_ARGUMENT		`familySearchOrder` is `null`
Errors	UNSUPPORTED		`familySearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFamilySearchRecord
Description	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	`osid.type.Type`	`familySearchRecordType`	a family search record type
Return	`osid.relationship.records.FamilySearchRecord`		the family search record
Errors	NULL_ARGUMENT		`familySearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(familySearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.