OSID - osid.relationship.rules.RelationshipEnablerQuerySession Service Interface Definition

Interface	osid.relationship.rules.RelationshipEnablerQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `RelationshipEnabler` objects. The search query is constructed using the `RelationshipEnablerQuery.` This session defines views that offer differing behaviors for searching. federated family view: searches include relationship enablers in families of which this family is an ancestor in the family hierarchy isolated family view: searches are restricted to relationship enablers in this family Relationship enablers may have a query record indicated by their respective record types. The query record is accessed via the `RelationshipEnablerQuery.`
Method	getFamilyId
Description	Gets the `Family` `Id` associated with this session.
Return	`osid.id.Id`		the `Family Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFamily
Description	Gets the `Family` associated with this session.
Return	`osid.relationship.Family`		the family
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRelationshipEnablers
Description	Tests if this user can perform `RelationshipEnabler` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedFamilyView
Description	Federates the view for methods in this session. A federated view will include relationship enablers in families which are children of this family in the family hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFamilyView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this family only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelationshipEnablerQuery
Description	Gets a relationship enabler query.
Return	`osid.relationship.rules.RelationshipEnablerQuery`		the relationship enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersByQuery
Description	Gets a list of `RelationshipEnablers` matching the given relationship enabler query.
Parameters	`osid.relationship.rules.RelationshipEnablerQuery`	`relationshipEnablerQuery`	the relationship enabler query
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnablerList`
Errors	NULL_ARGUMENT		`relationshipEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relationshipEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.