OSID - osid.relationship.FamilySearchSession Service Interface Definition

Interface	osid.relationship.FamilySearchSession
Implements	`osid.relationship.FamilyQuerySession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session provides methods for searching `Family` objects. The search query is constructed using the `FamilyQuery`. The family record `Type` also specifies the record for the family query. `getFamiliesByQuery()` is the basic search method and returns a list of `Family` elements. A more advanced search may be performed with `getFamiliesBySearch()`. It accepts a `FamilySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getFamiliesBySearch()` returns a `FamilySearchResults` that can be used to access the resulting `FamilyList` or be used to perform a search within the result set through `FamilySearch`. Families may have a query record indicated by their respective record types. The query record is accessed via the `FamilyQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getFamilySearch
Description	Gets a family search.
Return	`osid.relationship.FamilySearch`		the family search
Compliance	`mandatory`		This method must be implemented.
Method	getFamilySearchOrder
Description	Gets a family search order. The `FamilySearchOrder` is supplied to a `FamilySearch` to specify the ordering of results.
Return	`osid.relationship.FamilySearchOrder`		the family search order
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.relationship.FamilyQuery`	`familyQuery`	the family query
Parameters	`osid.relationship.FamilySearch`	`familySearch`	the family search
Return	`osid.relationship.FamilySearchResults`		the search results
Errors	NULL_ARGUMENT		`familyQuery` or `familySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`familyQuery` or `familySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyQueryFromInspector
Description	Gets a family query from an inspector. The inspector is available from an `FamilySearchResults`.
Parameters	`osid.relationship.FamilyQueryInspector`	`familyQueryInspector`	a family query inspector
Return	`osid.relationship.FamilyQuery`		the familyh query
Errors	NULL_ARGUMENT		`familyQueryInspector` is `null`
Errors	UNSUPPORTED		`familyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.