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

Interface	osid.relationship.rules.RelationshipEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.rules.RelationshipRulesManager`
Used By	`osid.relationship.rules.RelationshipRulesProxyManager`
Description	This session provides methods to retrieve `RelationshipEnabler` to `Relationship` mappings. A `Relationship` with multiple `RelationshipEnablers` means any positive rule evaluation across the enablers result in an enabled `Relationship`. 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 isolated family view: All methods in this session operate, retrieve and pertain relationship enablers defined explicitly in the current family. federated family view: All methods in this session operate, retrieve and pertain to all relationship enablers defined in this family and any other family enablers implicitly available in this family through family inheritence.
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	canLookupRelationshipEnablerRules
Description	Tests if this user can perform lookups of relationship enabler/relationship 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	useComparativeRelationshipEnablerRuleView
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	usePlenaryRelationshipEnablerRuleView
Description	A complete view of the `RelationshipEnabler` and `Relationship` 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	useFederatedFamilyView
Description	Federates the view for methods in this session. A federated view will include relationship enablers in families which are children of this family in the family hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFamilyView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this family only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelationshipEnablerIdsForRelationship
Description	Gets the `RelationshipEnabler Id` associated with a `Relationship`.
Parameters	`osid.id.Id`	`relationshipId`	`Id` of the `Relationship`
Return	`osid.id.IdList`		the relationship enabler `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	getRelationshipEnablersForRelationship
Description	Gets the `RelationshipEnabler` associated with a `Relationship`.
Parameters	`osid.id.Id`	`relationshipId`	`Id` of the `Relationship`
Return	`osid.relationship.rules.RelationshipEnablerList`		the relationship enablers
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	getRelationshipIdsForRelationshipEnabler
Description	Gets the `Relationship` `Ids` mapped to a `RelationshipEnabler`.
Parameters	`osid.id.Id`	`relationshipEnablerId`	`Id` of a `RelationshipEnabler`
Return	`osid.id.IdList`		list of relationship `Ids`
Errors	NOT_FOUND		`relationshipEnablerId` is not found
	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipsForRelationshipEnabler
Description	Gets the `Relationships` mapped to a `RelationshipEnabler`.
Parameters	`osid.id.Id`	`relationshipEnablerId`	`Id` of a `RelationshipEnabler`
Return	`osid.relationship.RelationshipList`		list of relationships
Errors	NOT_FOUND		`relationshipEnablerId` is not found
	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.