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

Interface	osid.relationship.rules.RelationshipEnablerFamilyAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.rules.RelationshipRulesManager`
Used By	`osid.relationship.rules.RelationshipRulesProxyManager`
Description	This session provides methods to re-assign `RelationshipEnabler` to `Family` mappings. A `RelationshipEnabler` may appear in multiple `Family` objects and removing the last reference to a `RelationshipEnabler` is the equivalent of deleting it. Each `Relationship` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `RelationshipEnabler` to another `Family` is not a copy operation (eg: does not change its `Id`).
Method	canAssignRelationshipEnablers
Description	Tests if this user can alter relationship enabler/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignRelationshipEnablersToFamily
Description	Tests if this user can alter relationship enabler/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 lookup 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 family enabler can be assigned.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Return	`osid.id.IdList`		list of assignable relationship `Ids`
Errors	NULL_ARGUMENT		`familyId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFamilyIdsForRelationshipEnabler
Description	Gets a list of families including and under the given family node in which a specific family enabler can be assigned.
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Return	`osid.id.IdList`		list of assignable family `Ids`
Errors	NULL_ARGUMENT		`familyId` or `relationshipEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignRelationshipEnablerToFamily
Description	Adds an existing `RelationshipEnabler` to a `Family`.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Errors	ALREADY_EXISTS		`relationshipEnablerId` is already assigned to `familyId`
	NOT_FOUND		`relationshipEnablerId` or `familyId` not found
	NULL_ARGUMENT		`relationshipEnablerId` or `familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRelationshipEnablerFromFamily
Description	Removes a `RelationshipEnabler` from a `Family`.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Parameters	`osid.id.Id`	`familyId`	the `Id` of the `Family`
Errors	NOT_FOUND		`relationshipEnablerId` or `familyId` not found or `relationshipEnablerId` is not assigned to `familyId`
	NULL_ARGUMENT		`relationshipEnablerId` or `familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignRelationshipEnablerToFamily
Description	Moves a `RelationshipEnabler` from one `Family` to another. Mappings to other `Families` are unaffected.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
	`osid.id.Id`	`fromFamilyId`	the `Id` of the current `Family`
	`osid.id.Id`	`toFamilyId`	the `Id` of the destination `Family`
Errors	ALREADY_EXISTS		`relationshipEnablerId` already assigned to `toFamilyId`
	NOT_FOUND		`relationshipEnablerId, fromFamilyId`, or `toFamilyId` not found or `relationshipEnablerId` not mapped to `fromFamilyId`
	NULL_ARGUMENT		`relationshipEnabelrId, fromFamilyId`, or `toFamilyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.