OSID - osid.relationship.FamilyQuerySession Service Interface Definition

Interface	osid.relationship.FamilyQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.relationship.FamilySearchSession`
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. 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	canSearchFamilies
Description	Tests if this user can perform `Family` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyQuery
Description	Gets a family query.
Return	`osid.relationship.FamilyQuery`		the family query
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByQuery
Description	Gets a list of `Family` objects matching the given family query.
Parameters	`osid.relationship.FamilyQuery`	`familyQuery`	the family query
Return	`osid.relationship.FamilyList`		the returned `FamilyList`
Errors	NULL_ARGUMENT		`familyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`familyQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.