OSID - osid.relationship.RelationshipFamilySession Service Interface Definition

Interface	osid.relationship.RelationshipFamilySession
Implements	`osid.OsidSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session provides methods to retrieve `Relationship` to `Family` mappings. A `Relationship` may appear in multiple `Family` objects. Each catalog may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupRelationshipFamilyMappings
Description	Tests if this user can perform lookups of relationship/family mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeFamilyView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryFamilyView
Description	A complete view of the `Relationship` and `Family` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelationshipIdsByFamily
Description	Gets the list of `Relationship Ids` associated with a `Family`.
Parameters	`osid.id.Id`	`familyId`	`Id` of the `Family`
Return	`osid.id.IdList`		list of related relationship `Ids`
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipsByFamily
Description	Gets the list of `Relationships` associated with a `Family`.
Parameters	`osid.id.Id`	`familyId`	`Id` of the `Family`
Return	`osid.relationship.RelationshipList`		list of related relationships
Errors	NOT_FOUND		`familyId` is not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipIdsByFamilies
Description	Gets the list of `Relationship Ids` corresponding to a list of `Family` objects.
Parameters	`osid.id.IdList`	`familyIds`	list of family `Ids`
Return	`osid.id.IdList`		list of relationship `Ids`
Errors	NULL_ARGUMENT		`familyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipsByFamilies
Description	Gets the list of `Relationships` corresponding to a list of `Family` objects.
Parameters	`osid.id.IdList`	`familyIds`	list of family `Ids`
Return	`osid.relationship.RelationshipList`		list of relationships
Errors	NULL_ARGUMENT		`familyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyIdsByRelationship
Description	Gets the `Family` `Ids` mapped to a `Relationship`.
Parameters	`osid.id.Id`	`relationshipId`	`Id` of a `Relationship`
Return	`osid.id.IdList`		list of family `Ids`
Errors	NOT_FOUND		`relationshipId` is not found
	NULL_ARGUMENT		`relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByRelationship
Description	Gets the `Family` objects mapped to a `Relationship`.
Parameters	`osid.id.Id`	`relationshipId`	`Id` of a `Relationship`
Return	`osid.relationship.FamilyList`		list of family `Ids`
Errors	NOT_FOUND		`relationshipId` is not found
	NULL_ARGUMENT		`relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.