OSID - osid.authorization.FunctionLookupSession Service Interface Definition

Interface	osid.authorization.FunctionLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Function` objects. This session defines two sets of views which offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete and ordered result set or is an error condition isolated vault view: All function methods in this session operate, retrieve and pertain to functions defined explicitly in the current vault. Using an isolated view is useful for managing functions with the `FunctionAdminSession.` federated vault view: All function methods in this session operate, retrieve and pertain to all functions defined in this vault and any other vaults implicitly available in this vault through vault inheritence. active function view: All function lookup methods return active functions. any status function view: Active and inactive functions are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision. Functions may have an additional records indicated by their respective record types.
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the `Vault` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupFunctions
Description	Tests if this user can perform `Function` 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	useComparativeFunctionView
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	usePlenaryFunctionView
Description	A complete view of the `Function` 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	useFederatedVaultView
Description	Federates the view for methods in this session. A federated view will include functions in vaults which are children of this vault in the vault hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedVaultView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveFunctionView
Description	Only active functions are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusFunctionView
Description	Active and inactive functions are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getFunction
Description	Gets the `Function` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Function` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Function` and retained for compatibility.
Parameters	`osid.id.Id`	`functionId`	the `Id` of the `Function` to retrieve
Return	`osid.authorization.Function`		the returned `Function`
Errors	NOT_FOUND		no `Function` found with the given `Id`
	NULL_ARGUMENT		`functionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsByIds
Description	Gets a `FunctionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the functions 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 `Functions` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`functionIds`	the list of `Ids` to retrieve
Return	`osid.authorization.FunctionList`		the returned `Function` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`functionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsByGenusType
Description	Gets a `FunctionList` corresponding to the given function genus `Type` which does not include functions of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
Parameters	`osid.type.Type`	`functionGenusType`	a function genus type
Return	`osid.authorization.FunctionList`		the returned `Function` list
Errors	NULL_ARGUMENT		`functionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsByParentGenusType
Description	Gets a `FunctionList` corresponding to the given function genus `Type` and include any additional functions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
Parameters	`osid.type.Type`	`functionGenusType`	a function genus type
Return	`osid.authorization.FunctionList`		the returned `Function` list
Errors	NULL_ARGUMENT		`functionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsByRecordType
Description	Gets a `FunctionList` containing the given function record `Type.` In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
Parameters	`osid.type.Type`	`functionRecordType`	a function record type
Return	`osid.authorization.FunctionList`		the returned `Function` list
Errors	NULL_ARGUMENT		`functionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getFunctions
Description	Gets all `Functions.` In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
Return	`osid.authorization.FunctionList`		a list of `Functions`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.