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

Interface	osid.relationship.rules.RelationshipRulesProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.relationship.rules.RelationshipRulesProfile`
Description	The relationship rules proxy manager provides access to relationship rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a `Proxy` for passing information from server environments. The sessions included in this manager are: `RelationshipEnablerLookupSession:` a session to retrieve relationship enablers `RelationshipEnablerQuerySession:` a session to query for relationship enablers `RelationshipEnablerSearchSession:` a session to search for relationship enablers `RelationshipEnablerAdminSession:` a session to create and delete relationship enablers `RelationshipEnablerNotificationSession:` a session to receive notifications pertaining to relationship enabler changes `RelationshipEnablerFamilySession:` a session to look up relationship enabler family mappings `RelationshipEnablerFamilyAssignmentSession:` a session to manage relationship enabler to family mappings `RelationshipEnablerSmartFamilySession:` a session to manage dynamic families of relationship enablers `RelationshipEnablerRuleLookupSession:` a session to look up relationship enabler to relationship mappings `RelationshipEnablerRuleApplicationSession:` a session to apply relationship enablers to relationships
Method	getRelationshipEnablerLookupSession
Description	Gets the `OsidSession` associated with the relationship enabler lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerLookupSession`		a `RelationshipEnablerLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerLookup()` is `true.`
Method	getRelationshipEnablerLookupSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler lookup service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerLookupSession`		a `RelationshipEnablerLookupSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerLookup()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerQuerySession
Description	Gets the `OsidSession` associated with the relationship enabler query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerQuerySession`		a `RelationshipEnablerQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerQuery()` is `true.`
Method	getRelationshipEnablerQuerySessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler query service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerQuerySession`		a `RelationshipEnablerQuerySession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerQuery()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerSearchSession
Description	Gets the `OsidSession` associated with the relationship enabler search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerSearchSession`		a `RelationshipEnablerSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerSearch()` is `true.`
Method	getRelationshipEnablerSearchSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enablers earch service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerSearchSession`		a `RelationshipEnablerSearchSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerSearch()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerAdminSession
Description	Gets the `OsidSession` associated with the relationship enabler administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerAdminSession`		a `RelationshipEnablerAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerAdmin()` is `true.`
Method	getRelationshipEnablerAdminSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler administration service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerAdminSession`		a `RelationshipEnablerAdminSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerNotificationSession
Description	Gets the `OsidSession` associated with the relationship enabler notification service.
Parameters	`osid.relationship.rules.RelationshipEnablerReceiver`	`relationshipEnablerReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerNotificationSession`		a `RelationshipEnablerNotificationSession`
Errors	NULL_ARGUMENT		`relationshipEnablerReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerNotification()` is `true.`
Method	getRelationshipEnablerNotificationSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler notification service for the given family.
Parameters	`osid.relationship.rules.RelationshipEnablerReceiver`	`relationshipEnablerReceiver`	the notification callback
	`osid.id.Id`	`familyId`	the `Id` of the `Family`
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerNotificationSession`		a `RelationshipEnablerNotificationSession`
Errors	NOT_FOUND		no family found by the given `Id`
	NULL_ARGUMENT		`relationshipEnablerReceiver, familyId,` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerNotification()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerFamilySession
Description	Gets the `OsidSession` to lookup relationship enabler/family mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerFamilySession`		a `RelationshipEnablerFamilySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerFamily()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerFamily()` is `true.`
Method	getRelationshipEnablerFamilyAssignmentSession
Description	Gets the `OsidSession` associated with assigning relationship enablers to families.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerFamilyAssignmentSession`		a `RelationshipEnablerFamilyAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerFamilyAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerFamilyAssignment()` is `true.`
Method	getRelationshipEnablerSmartFamilySession
Description	Gets the `OsidSession` to manage relationship enabler smart families.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerSmartFamilySession`		a `RelationshipEnablerSmartFamilySession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerSmartRelationship()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerSmartFamily()` is `true.`
Method	getRelationshipEnablerRuleLookupSession
Description	Gets the `OsidSession` associated with the relationship enabler mapping lookup service for looking up the rules applied to the relationship.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerRuleLookupSession`		a `RelationshipEnablerRuleLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerRuleLookup()` is `true.`
Method	getRelationshipEnablerRuleLookupSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler mapping lookup service for the given relationship for looking up rules applied to a relationship.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerRuleLookupSession`		a `RelationshipEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerRuleLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerRuleLookup()` and `supportsVisibleFederation()` are `true.`
Method	getRelationshipEnablerRuleApplicationSession
Description	Gets the `OsidSession` associated with the relationship enabler assignment service to apply enablers to relationships.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerRuleApplicationSession`		a `RelationshipEnablerRuleApplicationSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerRuleApplication()` is `true.`
Method	getRelationshipEnablerRuleApplicationSessionForFamily
Description	Gets the `OsidSession` associated with the relationship enabler assignment service for the given relationship to apply enablers to relationships.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.relationship.rules.RelationshipEnablerRuleApplicationSession`		a `RelationshipEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipEnablerRuleApplication()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipEnablerRuleApplication()` and `supportsVisibleFederation()` are `true.`