OSID - osid.recipe.ProcedureLookupSession Service Interface Definition

Interface	osid.recipe.ProcedureLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving procedures. 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 cook book view: All procedure methods in this session operate, retrieve and pertain to procedures defined explicitly in the current cookbook. Using an isolated view is useful for managing procedures with the `ProcedureAdminSession.` federated cook book view: All procedure lookup methods in this session operate, retrieve and pertain to all procedures defined in this cook book and any other cook books implicitly available in this cook book through cook book inheritence. The methods `useFederatedCookbookView()` and `useIsolatedCookbookView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProcedures
Description	Tests if this user can lookup procedures. 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 these operations.
Return	`boolean`		`false` if procedure lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProcedureView
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	usePlenaryProcedureView
Description	A complete view of the `Procedure` 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	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include procedures in cook books which are children of this cook book in the cook book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this cook book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getProcedure
Description	Gets the `Procedure` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Procedure` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Procedure` and retained for compatibility.
Parameters	`osid.id.Id`	`procedureId`	the `Id` of the `Procedure` to retrieve
Return	`osid.recipe.Procedure`		the returned `Procedure`
Errors	NOT_FOUND		no `Procedure` found with the given `Id`
	NULL_ARGUMENT		`procedureId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProceduresByIds
Description	Gets a `ProcedureList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the procedures 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 procedures may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`procedureIds`	the list of `Ids` to retrieve
Return	`osid.recipe.ProcedureList`		the returned `Procedure list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`procedureIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProceduresByGenusType
Description	Gets a `ProcedureList` corresponding to the given procedure genus `Type` which does not include procedures of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.
Parameters	`osid.type.Type`	`procedureGenusType`	a procedure genus type
Return	`osid.recipe.ProcedureList`		the returned `Procedure` list
Errors	NULL_ARGUMENT		`procedureGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProceduresByParentGenusType
Description	Gets a `ProcedureList` corresponding to the given procedure genus `Type` and include any additional procedures with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.
Parameters	`osid.type.Type`	`procedureGenusType`	a procedure genus type
Return	`osid.recipe.ProcedureList`		the returned `Procedure` list
Errors	NULL_ARGUMENT		`procedureGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProceduresByRecordType
Description	Gets a `ProcedureList` containing the given procedure record `Type.` In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.
Parameters	`osid.type.Type`	`procedureRecordType`	a procedure record type
Return	`osid.recipe.ProcedureList`		the returned `Procedure` list
Errors	NULL_ARGUMENT		`procedureRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcedures
Description	Gets all procedures. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.
Return	`osid.recipe.ProcedureList`		a list of procedures
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.