OSID - osid.relationship.RelationshipManager Service Interface Definition

Interface	osid.relationship.RelationshipManager
Implements	`osid.OsidManager`
Implements	`osid.relationship.RelationshipProfile`
Description	The relationship manager provides access to relationship sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `RelationshipLookupSession:` a session to retrieve and examine relationships `RelationshipQuerySession:` a session to query relationships `RelationshipSearchSession:` a session to search for relationships `RelationshipAdminSession:` a session to manage relationships `RelationshipNotificationSession:` a session to receive notifications pertaining to relationship changes `RelationshipFamilySession:` a session to look up relationship to family mappings `RelationshipFamilyAssignmentSession:` a session to manage relationship to family catalog mappings `RelationshipSmartFamilySession:` a session to manage dynamic relationship families `FamilyLookupSession:` a session to retrieve families `FamilyQuerySession:` a session to query families `FamilySearchSession:` a session to search for families `FamilyAdminSession:` a session to create and delete families `FamilyNotificationSession:` a session to receive notifications pertaining to family changes `FamilyHierarchySession:` a session to traverse a hierarchy of families `FamilyHierarchyDesignSession:` a session to manage a family hierarchy
Method	getRelationshipLookupSession
Description	Gets the `OsidSession` associated with the relationship lookup service.
Return	`osid.relationship.RelationshipLookupSession`		a `RelationshipLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipLookup()` is `true.`
Method	getRelationshipLookupSessionForFamily
Description	Gets the `OsidSession` associated with the relationship lookup service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the family
Return	`osid.relationship.RelationshipLookupSession`		a `RelationshipLookupSession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipLookup()` and `supportsVisibleFederation()` are `true`
Method	getRelationshipQuerySession
Description	Gets the `OsidSession` associated with the relationship query service.
Return	`osid.relationship.RelationshipQuerySession`		a `RelationshipQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipQuery()` is `true.`
Method	getRelationshipQuerySessionForFamily
Description	Gets the `OsidSession` associated with the relationship query service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the family
Return	`osid.relationship.RelationshipQuerySession`		a `RelationshipQuerySession`
Errors	NOT_FOUND		no `Family` found by the given `Id`
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipQuery()` and `supportsVisibleFederation()` are `true`
Method	getRelationshipSearchSession
Description	Gets the `OsidSession` associated with the relationship search service.
Return	`osid.relationship.RelationshipSearchSession`		a `RelationshipSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipSearch()` is `true.`
Method	getRelationshipSearchSessionForFamily
Description	Gets the `OsidSession` associated with the relationship search service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.relationship.RelationshipSearchSession`		a `RelationshipSearchSession`
Errors	NOT_FOUND		no family found by the given `Id`
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipSearch()` and `supportsVisibleFederation()` are `true`
Method	getRelationshipAdminSession
Description	Gets the `OsidSession` associated with the relationship administration service.
Return	`osid.relationship.RelationshipAdminSession`		a `RelationshipAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipAdmin()` is `true.`
Method	getRelationshipAdminSessionForFamily
Description	Gets the `OsidSession` associated with the relationship administration service for the given family.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.relationship.RelationshipAdminSession`		a `RelationshipAdminSession`
Errors	NOT_FOUND		no family found by the given `Id`
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRelationshipNotificationSession
Description	Gets the `OsidSession` associated with the relationship notification service.
Parameters	`osid.relationship.RelationshipReceiver`	`relationshipReceiver`	the receiver
Return	`osid.relationship.RelationshipNotificationSession`		a `RelationshipNotificationSession`
Errors	NULL_ARGUMENT		`relationshipReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipNotification()` is `true.`
Method	getRelationshipNotificationSessionForFamily
Description	Gets the `OsidSession` associated with the relationship notification service for the given family.
Parameters	`osid.relationship.RelationshipReceiver`	`relationshipReceiver`	the receiver
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.relationship.RelationshipNotificationSession`		a `RelationshipNotificationSession`
Errors	NOT_FOUND		no family found by the given `Id`
	NULL_ARGUMENT		`relationshipReceiver` or `familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipNotification()` and `supportsVisibleFederation()` are `true`
Method	getRelationshipFamilySession
Description	Gets the `OsidSession` to lookup relationship/family mappings.
Return	`osid.relationship.RelationshipFamilySession`		a `RelationshipFamilySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipFamily()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipFamily()` is `true.`
Method	getRelationshipFamilyAssignmentSession
Description	Gets the `OsidSession` associated with assigning relationships to families.
Return	`osid.relationship.RelationshipFamilyAssignmentSession`		a `RelationshipFamilyAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipFamilyAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipFamilyAssignment()` is `true.`
Method	getRelationshipSmartFamilySession
Description	Gets the `OsidSession` to manage dynamic families of retlationships.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.relationship.RelationshipSmartFamilySession`		a `RelationshipSmartFamilySession`
Errors	NOT_FOUND		no family found by the given `Id`
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRelationshipSmartFamily()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipSmartFamily()` is `true.`
Method	getFamilyLookupSession
Description	Gets the `OsidSession` associated with the family lookup service.
Return	`osid.relationship.FamilyLookupSession`		a `FamilyLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilyLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyLookup()` is `true.`
Method	getFamilyQuerySession
Description	Gets the `OsidSession` associated with the family query service.
Return	`osid.relationship.FamilyQuerySession`		a `FamilyQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyQuery()` is `true.`
Method	getFamilySearchSession
Description	Gets the `OsidSession` associated with the family search service.
Return	`osid.relationship.FamilySearchSession`		a `FamilySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilySearch()` is `true.`
Method	getFamilyAdminSession
Description	Gets the `OsidSession` associated with the family administrative service.
Return	`osid.relationship.FamilyAdminSession`		a `FamilyAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilyAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyAdmin()` is `true.`
Method	getFamilyNotificationSession
Description	Gets the `OsidSession` associated with the family notification service.
Parameters	`osid.relationship.FamilyReceiver`	`familyReceiver`	the receiver
Return	`osid.relationship.FamilyNotificationSession`		a `FamilyNotificationSession`
Errors	NULL_ARGUMENT		`familyReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFamilyNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyNotification()` is `true.`
Method	getFamilyHierarchySession
Description	Gets the `OsidSession` associated with the family hierarchy service.
Return	`osid.relationship.FamilyHierarchySession`		a `FamilyHierarchySession` for families
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilyHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyHierarchy()` is `true.`
Method	getFamilyHierarchyDesignSession
Description	Gets the `OsidSession` associated with the family hierarchy design service.
Return	`osid.relationship.FamilyHierarchyDesignSession`		a `HierarchyDesignSession` for families
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFamilyHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFamilyHierarchyDesign()` is `true.`
Method	getRelationshipBatchManager
Description	Gets the relationship batch manager.
Return	`osid.relationship.batch.RelationshipBatchManager`		a `RelationshipBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipBatch()` is `true.`
Method	getRelationshipRulesManager
Description	Gets the relationship rules manager.
Return	`osid.relationship.rules.RelationshipRulesManager`		a `RelationshipRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRelationshipRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRelationshipRules()` is `true.`