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

Interface	osid.relationship.rules.RelationshipEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `RelationshipEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated family view: All relationship enabler methods in this session operate, retrieve and pertain to relationship enablers defined explicitly in the current family. Using an isolated view is useful for managing `RelationshipEnablers` with the `RelationshipEnablerAdminSession.` federated family view: All relationship enabler methods in this session operate, retrieve and pertain to all relationship enablers defined in this family and any other relationship enablers implicitly available in this family through family inheritence. active relationship enabler view: All relationship enabler lookup methods return active relationship enablers. any status relationship enabler view: Relationship enablers of any active or inactive status are returned from methods.
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	canLookupRelationshipEnablers
Description	Tests if this user can perform `RelationshipEnablers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRelationshipEnablerView
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	usePlenaryRelationshipEnablerView
Description	A complete view of the `RelationshipEnabler` 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	useActiveRelationshipEnablerView
Description	Only active relationship enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRelationshipEnablerView
Description	All active and insactive relationship enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRelationshipEnabler
Description	Gets the `RelationshipEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RelationshipEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RelationshipEnabler` and retained for compatibility. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.id.Id`	`relationshipEnablerId`	`Id` of the `RelationshipEnabler`
Return	`osid.relationship.rules.RelationshipEnabler`		the relationship enabler
Errors	NOT_FOUND		`relationshipEnablerId` not found
	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRelationshipEnablersByIds
Description	Gets a `RelationshipEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the relationship enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `RelationshipEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.id.IdList`	`relationshipEnablerIds`	the list of `Ids` to retrieve
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`relationshipEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersByGenusType
Description	Gets a `RelationshipEnablerList` corresponding to the given relationship enabler genus `Type` which does not include relationship enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.type.Type`	`relationshipEnablerGenusType`	a relationship enabler genus type
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	NULL_ARGUMENT		`relationshipEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersByParentGenusType
Description	Gets a `RelationshipEnablerList` corresponding to the given relationship enabler genus `Type` and include any additional relationship enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.type.Type`	`relationshipEnablerGenusType`	a relationship enabler genus type
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	NULL_ARGUMENT		`relationshipEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersByRecordType
Description	Gets a `RelationshipEnablerList` containing the given relationship enabler record `Type.` In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.type.Type`	`relationshipEnablerRecordType`	a relationship enabler record type
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	NULL_ARGUMENT		`relationshipEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersOnDate
Description	Gets a `RelationshipEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablersOnDateWithAgent
Description	Gets a `RelationshipEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablers
Description	Gets all `RelationshipEnablers.` In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.
Return	`osid.relationship.rules.RelationshipEnablerList`		the returned `RelationshipEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.