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

Interface	osid.relationship.rules.RelationshipEnablerSmartFamilySession
Implements	`osid.OsidSession`
Used By	`osid.relationship.rules.RelationshipRulesManager`
Used By	`osid.relationship.rules.RelationshipRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic families. A `RelationshipEnablerQuery` can be retrieved from this session and mapped to this `Family` to create a virtual collection of relationship enablers. The relationship enablers may be sequenced using the `RelationshipEnablerSearchOrder` from this session. This `Family` has a default query that matches any relationship enabler and a default search order that specifies no sequencing. The queries may be examined using a `RelationshipEnablerQueryInspector`. The query may be modified by converting the inspector back to a `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	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 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 operations to unauthorized users.
Return	`boolean`		`false` if smart family management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getRelationshipEnablerSearchOrder
Description	Gets a relationship enabler search order.
Return	`osid.relationship.rules.RelationshipEnablerSearchOrder`		the relationship enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRelationshipEnablerQuery
Description	Applies a relationship enabler query to this family.
Parameters	`osid.relationship.rules.RelationshipEnablerQuery`	`relationshipEnablerQuery`	the relationship enabler query
Errors	NULL_ARGUMENT		`relationshipEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relationshipEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRelationshipEnablerQuery
Description	Gets a relationship enabler query inspector for this family.
Return	`osid.relationship.rules.RelationshipEnablerQueryInspector`		the relationship enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRelationshipEnablerSequencing
Description	Applies a relationship enabler search order to this family.
Parameters	`osid.relationship.rules.RelationshipEnablerSearchOrder`	`relationshipEnablerSearchOrder`	the relationship enabler search order
Errors	NULL_ARGUMENT		`relationshipEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`relationshipEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerQueryFromInspector
Description	Gets a relationship enabler query from an inspector.
Parameters	`osid.relationship.rules.RelationshipEnablerQueryInspector`	`relationshipEnablerQueryInspector`	a relationship enabler query inspector
Return	`osid.relationship.rules.RelationshipEnablerQuery`		the relationship enabler query
Errors	NULL_ARGUMENT		`relationshipEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`relationshipEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.