OSID - osid.relationship.RelationshipSmartFamilySession Service Interface Definition

Interface	osid.relationship.RelationshipSmartFamilySession
Implements	`osid.OsidSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RelationshipQuery` can be retrieved from this session and mapped to this `Family` to create a virtual collection of `Relationships`. The entries may be sequenced using the `RelationshipSearchOrder` from this session. This `Family` has a default query that matches any relationship and a default search order that specifies no sequencing. The queries may be examined using a `RelationshipQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartFamilies
Description	Tests if this user can manage smart families. 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 smart operations.
Return	`boolean`		`false` if smart family 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	getRelationshipSearchOrder
Description	Gets a relationship search order.
Return	`osid.relationship.RelationshipSearchOrder`		the relationship search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRelationshipQuery
Description	Applies a relationship query to this family.
Parameters	`osid.relationship.RelationshipQuery`	`relationshipQuery`	the relationship query
Errors	NULL_ARGUMENT		`relationshipQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relationshipQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRelationshipQuery
Description	Gets a relationship query inspector for this family.
Return	`osid.relationship.RelationshipQueryInspector`		the relationship query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRelationshipSequencing
Description	Applies a relationship search order to this family.
Parameters	`osid.relationship.RelationshipSearchOrder`	`relationshipSearchOrder`	the relationship search order
Errors	NULL_ARGUMENT		`relationshipSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relationshipSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipQueryFromInspector
Description	Gets a relationship query from an inspector.
Parameters	`osid.relationship.RelationshipQueryInspector`	`relationshipQueryInspector`	a relationship query inspector
Return	`osid.relationship.RelationshipQuery`		the relationship query
Errors	NULL_ARGUMENT		`relatinshipQueryInspector` is `null`
Errors	UNSUPPORTED		`relationshipQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.