OSID - osid.resource.ResourceLookupSession Service Interface Definition

Interface	osid.resource.ResourceLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving resources. A `Resource` is an arbitrary entity that may represent a person, place or thing used to identify an object used in various services. 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 bin view: All resource methods in this session operate, retrieve and pertain to resources defined explicitly in the current bin. Using an isolated view is useful for managing `Resources` with the `ResourceAdminSession.` federated bin view: All resource methods in this session operate, retrieve and pertain to all resources defined in this bin and any other resources implicitly available in this bin through bin inheritence. The methods `useFederatedBinView()` and `useIsolatedBinView()` behave as a radio group and one should be selected before invoking any lookup methods. Resources may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Resource.`
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	canLookupResources
Description	Tests if this user can perform `Resource` 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResourceView
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	usePlenaryResourceView
Description	A complete view of the `Resource` 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 resources 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 lookups to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	getResource
Description	Gets the `Resource` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Resource` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Resource` and retained for compatibility.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to retrieve
Return	`osid.resource.Resource`		the returned `Resource`
Errors	NOT_FOUND		no `Resource` found with the given `Id`
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByIds
Description	Gets a `ResourceList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the resources 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 `Resources` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`resourceIds`	the list of `Ids` to retrieve
Return	`osid.resource.ResourceList`		the returned `Resource` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByGenusType
Description	Gets a `ResourceList` corresponding to the given resource genus `Type` which does not include resources of types derived from the specified `Type.` In plenary mode, the returned list contains all known resources or an error results. Otherwise, the returned list may contain only those resources that are accessible through this session.
Parameters	`osid.type.Type`	`resourceGenusType`	a resource genus type
Return	`osid.resource.ResourceList`		the returned `Resource` list
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByParentGenusType
Description	Gets a `ResourceList` corresponding to the given resource genus `Type` and include any additional resources with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known resources or an error results. Otherwise, the returned list may contain only those resources that are accessible through this session.
Parameters	`osid.type.Type`	`resourceGenusType`	a resource genus type
Return	`osid.resource.ResourceList`		the returned `Resource` list
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByRecordType
Description	Gets a `ResourceList` containing the given resource record `Type.` In plenary mode, the returned list contains all known resources or an error results. Otherwise, the returned list may contain only those resources that are accessible through this session.
Parameters	`osid.type.Type`	`resourceRecordType`	a resource record type
Return	`osid.resource.ResourceList`		the returned `Resource` list
Errors	NULL_ARGUMENT		`resourceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResources
Description	Gets all `Resources.` In plenary mode, the returned list contains all known resources or an error results. Otherwise, the returned list may contain only those resources that are accessible through this session.
Return	`osid.resource.ResourceList`		a list of `Resources`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.