OSID - osid.resource.ResourceRelationshipLookupSession Service Interface Definition

Interface	osid.resource.ResourceRelationshipLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for examining resource 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 isolated bin view: All relationship methods in this session operate, retrieve and pertain to relationships defined explicitly in the current bin. Using an isolated view is useful for managing relationships with the `ResourceRelationshipAdminSession.` federated bin view: All relationship methods in this session operate, retrieve and pertain to all relationships defined in this bin and any other catalogs implicitly available in this bin through bin inheritence. effective resource relationship view: All resource relationship lookup methods return resource relationships where the current date falls in between the effective dates inclusive. any resource relationship view: Resource relationships of any effective date are returned from methods.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupResourceRelationships
Description	Tests if this user can access resource relationships. 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 relationship operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResourceRelationshipView
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	usePlenaryResourceRelationshipView
Description	A complete view of the resource 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	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include relationships in bins which are children of this bin in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts relationships to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveResourceRelationshipView
Description	Only resource relationships whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveResourceRelationshipView
Description	All resource relationships of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceRelationship
Description	Gets the `ResourceRelationship` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Relationship` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Relationship` and retained for compatibility. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceRelationshipId`	`Id` of the `Relationship`
Return	`osid.resource.ResourceRelationship`		the relationship
Errors	NOT_FOUND		`resourceRelationshipId` not found
	NULL_ARGUMENT		`resourceRelationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceRelationshipsByIds
Description	Gets a `ResourceRelationshipList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the relationships 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 `Relationships` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.IdList`	`resourceRelationshipIds`	the list of `Ids` to retrieve
Return	`osid.resource.ResourceRelationshipList`		the returned `ResourceRelationship` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`resourceRelationshipIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusType
Description	Gets the resource relationships for the given resource relationship genus type. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByParentGenusType
Description	Gets the reource relationships for the given resource relationship genus type and include any relationships with a genus type derived from the specified genus type. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByRecordType
Description	Gets the resource relationships for the given resource relationship record type. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.type.Type`	`relationshipRecordType`	a relationship record type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`relationshipRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsOnDate
Description	Gets the resource relationships effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.resource.ResourceRelationshipList`		the relationships
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	getResourceRelationshipsForSourceResource
Description	Gets the `ResourceRelationships` of a resource. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	`Id` of a `Resource`
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`sourceResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsForSourceResourceOnDate
Description	Gets a list of resource relationships for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`sourceResourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForSourceResource
Description	Gets the `ResourceRelationships` of a resource of relationship genus type that includes any genus type derived from the given one. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	`Id` of a `Resource`
Parameters	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`sourceResourceId` or `relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForSourceResourceOnDate
Description	Gets a list of resource relationships of a given genus type for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	a resource `Id`
	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`sourceResourceId, relationshipGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsForDestinationResource
Description	Gets the `ResourceRelationships` of a resource. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`destinationResourceId`	`Id` of a `Resource`
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`destinationResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsForDestinationResourceOnDate
Description	Gets a list of resource relationships for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`destinationResourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForDestinationResource
Description	Gets the `ResourceRelationships` of a resource of relationship genus type that includes any genus type derived from the given one. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`destinationResourceId`	`Id` of a `Resource`
Parameters	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`destinationResourceId` or `relationshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForDestinationResourceOnDate
Description	Gets a list of resource relationships of a given genus type for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`destinationResourceId`	a resource `Id`
	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`destinationResourceId, relationshipGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsForResources
Description	Gets the `ResourceRelationships` given two resources. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	`Id` of a `Resource`
Parameters	`osid.id.Id`	`destinationResourceId`	`Id` of another `Resource`
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`sourceRelationshipId` or `destinationRelationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsForResourcesOnDate
Description	Gets a list of resource relationships for a two peer resources and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	a resource `Id`
	`osid.id.Id`	`destinationResourceId`	`Id` of another `Resource`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`sourceResourceId, destinationResourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForResources
Description	Gets the `ResourceRelationships` given two resources and a relationship genus type which includes any genus types derived from the given genus type. In plenary mode, the returned list contains all known relationships or an error results. Otherwise, the returned list may contain only those relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	`Id` of a `Resource`
	`osid.id.Id`	`destinationResourceId`	`Id` of another `Resource`
	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	NULL_ARGUMENT		`sourceResourceId, destinationResourceId,` or `relatonshipGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipsByGenusTypeForResourcesOnDate
Description	Gets a list of resource relationships of a given genus type for a two peer resources and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective in addition to being effective during the given dates. In any effective mode, effective resource relationships and those currently expired are returned.
Parameters	`osid.id.Id`	`sourceResourceId`	a resource `Id`
	`osid.id.Id`	`destinationResourceId`	`Id` of another `Resource`
	`osid.type.Type`	`relationshipGenusType`	a relationship genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`sourceResourceId, destinationResourceId, relationshipGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationships
Description	Gets all `ResourceRelationships.` In plenary mode, the returned list contains all known resource relationships or an error results. Otherwise, the returned list may contain only those resource relationships that are accessible through this session. In effective mode, resource relationships are returned that are currently effective. In any effective mode, effective resource relationships and those currently expired are returned.
Return	`osid.resource.ResourceRelationshipList`		the relationships
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.