OSID - osid.sequencing.ChainLookupSession Service Interface Definition

Interface	osid.sequencing.ChainLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving chains. 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 antimatroid view: All chain methods in this session operate, retrieve and pertain to chains defined explicitly in the current antimatroid. Using an isolated view is useful for managing `Chains` with the `ChainAdminSession.` federated antimatroid view: All chain lookup methods in this session operate, retrieve and pertain to all chains defined in this antimatroid and any other chains implicitly available in this antimatroid through antimatroid inheritence. The methods `useFederatedAntimatroidView()` and `useIsolatedAntimatroidView()` behave as a radio group and one should be selected before invoking any lookup methods. Chains may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the chains.
Method	getAntimatroidId
Description	Gets the `Antimatroid` `Id` associated with this session.
Return	`osid.id.Id`		the `Antimatroid Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroid
Description	Gets the `Antimatroid` associated with this session.
Return	`osid.sequencing.Antimatroid`		the antimatroid
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupChains
Description	Tests if this user can perform `Chain` 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	useComparativeChainView
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	usePlenaryChainView
Description	A complete view of the `Chain` 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	useFederatedAntimatroidView
Description	Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAntimatroidView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this antimatroid only.
Compliance	`mandatory`		This method is must be implemented.
Method	getChain
Description	Gets the `Chain` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Chain` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Chain` and retained for compatibility.
Parameters	`osid.id.Id`	`chainId`	the `Id` of the `Chain` to retrieve
Return	`osid.sequencing.Chain`		the returned `Chain`
Errors	NOT_FOUND		no `Chain` found with the given `Id`
	NULL_ARGUMENT		`chainId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChainsByIds
Description	Gets a `ChainList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the chains 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 `Chains` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`chainIds`	the list of `Ids` to retrieve
Return	`osid.sequencing.ChainList`		the returned `Chain` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`chainIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChainsByGenusType
Description	Gets a `ChainList` corresponding to the given chain genus `Type` which does not include chains of types derived from the specified `Type.` In plenary mode, the returned list contains all known chains or an error results. Otherwise, the returned list may contain only those chains that are accessible through this session.
Parameters	`osid.type.Type`	`chainGenusType`	a chain genus type
Return	`osid.sequencing.ChainList`		the returned `Chain` list
Errors	NULL_ARGUMENT		`chainGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChainsByParentGenusType
Description	Gets a `ChainList` corresponding to the given chain genus `Type` and include any additional chains with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known chains or an error results. Otherwise, the returned list may contain only those chains that are accessible through this session.
Parameters	`osid.type.Type`	`chainGenusType`	a chain genus type
Return	`osid.sequencing.ChainList`		the returned `Chain` list
Errors	NULL_ARGUMENT		`chainGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChainsByRecordType
Description	Gets a `ChainList` containing the given chain record `Type.` In plenary mode, the returned list contains all known chains or an error results. Otherwise, the returned list may contain only those chains that are accessible through this session.
Parameters	`osid.type.Type`	`chainRecordType`	a chain record type
Return	`osid.sequencing.ChainList`		the returned `Chain` list
Errors	NULL_ARGUMENT		`chainRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChains
Description	Gets all chains. In plenary mode, the returned list contains all of the chains including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Chains` may be omitted from the list and may present the elements in any order including returning a unique set.
Return	`osid.sequencing.ChainList`		the returned `Chain` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.