OSID - osid.relationship.RelationshipQuerySession Service Interface Definition

Interface	osid.relationship.RelationshipQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.relationship.RelationshipSearchSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session provides methods for searching among `Relationship` objects. The search query is constructed using the `Relationship`. Relationships may have a query record indicated by their respective record types. The query record is accessed via the `RelationshipQuery`.
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	useFederatedFamilyView
Description	Federates the view for methods in this session. A federated view will include relationships 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 retrievals to this family only.
Compliance	`mandatory`		This method is must be implemented.
Method	canSearchRelationships
Description	Tests if this user can perform `Relationship` 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	getRelationshipQuery
Description	Gets a relationship query.
Return	`osid.relationship.RelationshipQuery`		the relationship query
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipsByQuery
Description	Gets a list of `Relationships` matching the given relationship query.
Parameters	`osid.relationship.RelationshipQuery`	`relationshipQuery`	the relationship query
Return	`osid.relationship.RelationshipList`		the returned `RelationshipList`
Errors	NULL_ARGUMENT		`relationshipQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relationshipQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.