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

Interface	osid.relationship.rules.RelationshipEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `RelationshipEnablers` to `Relationships.` A `Relationship` with multiple `RelationshipEnablers` means any positive rule evaluation across the enablers result in an effective `Relationship.`
Method	getFamilyId
Description	Gets the `Family` `Id` associated with this session.
Return	`osid.id.Id`		the `Family Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFamily
Description	Gets the `Family` associated with this session.
Return	`osid.relationship.Family`		the family
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignRelationshipEnablers
Description	Tests if this user can alter relationship enabler/relationship 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	assignRelationshipEnablerToRelationship
Description	Adds an existing `RelationshipEnabler` to a `Relationship.`
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
Errors	ALREADY_EXISTS		`relationshipEnablerId` is already applied to `relationshipId`
	NOT_FOUND		`relationshipEnablerId` or `relationshipId` not found
	NULL_ARGUMENT		`relationshipEnablerId` or `relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRelationshipEnablerFromRelationship
Description	Removes a `RelationshipEnabler` from a `Relationship.`
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of the `Relationship`
Errors	NOT_FOUND		`relationshipEnablerId` or `relationshipId` not found or `relationshipEnablerId` not applied to `relationshipId`
	NULL_ARGUMENT		`relationshipEnablerId` or `relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceRelationshipEnablers
Description	Tests if this user can order `RelationshipEnablers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `RelationshipEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveRelationshipEnablerAhead
Description	Reorders relationship enablers for a relationship by moving the specified relationship enabler in front of a reference relationship enabler.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of a `RelationshipnEnabler`
	`osid.id.Id`	`relationshipId`	the `Id` of a `Relationship`
	`osid.id.Id`	`referenceId`	the reference relationship enabler `Id`
Errors	NOT_FOUND		`relationshipEnablerId, relationshipId,` or `referenceId` not found or, `relationshipnEnablerId` or `referenceId` not related to `relationshipId`
	NULL_ARGUMENT		`relationshipEnablerId, relationshipId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveRelationshipEnablerBehind
Description	Reorders relationship enablers for a relationship by moving the specified relationship enabler behind a reference relationship enabler.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of a `RelationshipnEnabler`
	`osid.id.Id`	`relationshipId`	the `Id` of a `Relationship`
	`osid.id.Id`	`referenceId`	the reference relationship enabler `Id`
Errors	NOT_FOUND		`relationshipEnablerId, relationshipId,` or `referenceId` not found or, `relationshipnEnablerId` or `referenceId` not related to `relationshipId`
	NULL_ARGUMENT		`relationshipEnablerId, relationshipId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderRelationshipEnablers
Description	Reorders a set of relationship enablers for a relationship.
Parameters	`osid.id.Id[]`	`relationshipEnablerIds`	the `Ids` for a set of `RelationshipnEnablers`
Parameters	`osid.id.Id`	`relationshipId`	the `Id` of a `Relationship`
Errors	NOT_FOUND		`relationshipId` not found or, an `relationshipEnablerId` not related to `relationshipId`
	NULL_ARGUMENT		`relationshipEnablerIds` or `relationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.