OSID - osid.relationship.RelationshipFamilyAssignmentSession Service Interface Definition

Interface	osid.relationship.RelationshipFamilyAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session provides methods to re-assign `Relationships` to `Family` objects A `Relationship` may appear in multiple `Family` objects and removing the last reference to a `Relationship` is the equivalent of deleting it. Each `Family` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of a `Relationship` to another `Family` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignRelationships
Description	Tests if this user can alter relationship/family mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignRelationshipsToFamily
Description	Tests if this user can alter relationship/family mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`familyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFamilyIds
Description	Gets a list of families including and under the given family node in which any relationship can be assigned.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.id.IdList`		list of assignable family `Ids`
Errors	NULL_ARGUMENT		`familyId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFamilyIdsForRelationship
Description	Gets a list of families including and under the given family node in which a specific relationship can be assigned.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
Return	`osid.id.IdList`		list of assignable family `Ids`
Errors	NULL_ARGUMENT		`familyId` or `relationshipId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignRelationshipToFamily
Description	Adds an existing `Relationship` to a `Family`.
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Errors	ALREADY_EXISTS		`relationshipId` is already assigned to `familyId`
	NOT_FOUND		`relationshipId` or `familyId` not found
	NULL_ARGUMENT		`relationshipId` or `familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRelationshipFromFamily
Description	Removes a `Relationship` from a `Family`.
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Errors	NOT_FOUND		`relationshipId` or `familyId` not found or `relationshipId` not assigned to `familyId`
	NULL_ARGUMENT		`relationshipId` or `familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignRelationshipToFamily
Description	Moves a `Relationship` from one `Family` to another. Mappings to other `Families` are unaffected.
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
	`osid.id.Id`	`fromFamilyId`	the `Id` of the current `Family`
	`osid.id.Id`	`toFamilyId`	the `Id` of the destination `Family`
Errors	ALREADY_EXISTS		`relationshipId` already assigned to `toFamilyId`
	NOT_FOUND		`relationshipId, fromFamilyId`, or `toFamilyId` not found or `relationshipId` not mapped to `fromFamilyId`
	NULL_ARGUMENT		`relationshipId, fromFamilyId`, or `toFamilyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.