OSID - osid.relationship.FamilyLookupSession Service Interface Definition

Interface	osid.relationship.FamilyLookupSession
Implements	`osid.OsidSession`
Used By	`osid.relationship.RelationshipManager`
Used By	`osid.relationship.RelationshipProxyManager`
Description	This session provides methods for retrieving `Family` objects. The `Family` represents a collection of relationships. 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 Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the `Families` it can access, without breaking execution. However, an assessment may only be useful if all `Families` referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.
Method	canLookupFamilies
Description	Tests if this user can perform `Family` 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 not 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	useComparativeFamilyView
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	usePlenaryFamilyView
Description	A complete view of the `Family` 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	getFamily
Description	Gets the `Family` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Family` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Family` and retained for compatibil
Parameters	`osid.id.Id`	`familyId`	`Id` of the `Family`
Return	`osid.relationship.Family`		the family
Errors	NOT_FOUND		`familyId` not found
	NULL_ARGUMENT		`familyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getFamiliesByIds
Description	Gets a `FamilyList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the families 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 families may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`familyIds`	the list of `Ids` to retrieve
Return	`osid.relationship.FamilyList`		the returned `Family list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`familyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByGenusType
Description	Gets a `FamilyList` corresponding to the given family genus `Type` which does not include families of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.
Parameters	`osid.type.Type`	`familyGenusType`	a family genus type
Return	`osid.relationship.FamilyList`		the returned `Family list`
Errors	NULL_ARGUMENT		`familyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByParentGenusType
Description	Gets a `FamilyList` corresponding to the given family genus `Type` and include any additional families with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.
Parameters	`osid.type.Type`	`familyGenusType`	a family genus type
Return	`osid.relationship.FamilyList`		the returned `Family list`
Errors	NULL_ARGUMENT		`familyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByRecordType
Description	Gets a `FamilyList` containing the given family record `Type`. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.
Parameters	`osid.type.Type`	`familyRecordType`	a family record type
Return	`osid.relationship.FamilyList`		the returned `Family list`
Errors	NULL_ARGUMENT		`familyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamiliesByProvider
Description	Gets a `FamilyList` from the given provider. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.relationship.FamilyList`		the returned `Family list`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFamilies
Description	Gets all families. In plenary mode, the returned list contains all known families or an error results. Otherwise, the returned list may contain only those families that are accessible through this session.
Return	`osid.relationship.FamilyList`		a list of families
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.