OSID - osid.grading.calculation.GradebookColumnCalculationLookupSession Service Interface Definition

Interface	osid.grading.calculation.GradebookColumnCalculationLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `GradebookColumnCalculationss` . 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 gradebook view: All gradebook column calculation methods in this session operate, retrieve and pertain to gradebook column calculations defined explicitly in the current gradebook. federated gradebook view: All gradebook column calculation methods in this session operate, retrieve and pertain to all gradebook column calculations defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence. active gradebook calculation view: All gradebook column calculation lookup methods return active gradebook column calculations. any status gradebook column calculation view: Gradebook column calculations of any active or inactive status are returned from methods. Gradebook column calculations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `GradebookColumnCalculation.`
Method	getGradebookId
Description	Gets the `Gradebook` `Id` associated with this session.
Return	`osid.id.Id`		the `Gradebook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGradebook
Description	Gets the `Gradebook` associated with this session.
Return	`osid.grading.Gradebook`		the `Gradebook` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupGradebookColumnCalculations
Description	Tests if this user can perform `GradebookColumnCalculation` 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 to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeGradebookColumnCalculationView
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	usePlenaryGradebookColumnCalculationView
Description	A complete view of the `GradebookColumnCalculation` 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	useFederatedGradebookView
Description	Federates the view for methods in this session. A federated view will include gradebook column calculations in gradebooks which are children of this gradebook in the gradebook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGradebookView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this gradebook only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveGradebookColumnCalculationView
Description	Only active gradebook column calculations are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusGradebookColumnCalculationView
Description	All active and inactive gradebook column calculations are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getGradebookColumnCalculation
Description	Gets the `GradebookColumnCalculation` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradebookColumnCalculation` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradebookColumnCalculation` and retained for compatibility.
Parameters	`osid.id.Id`	`gradebookColumnCalculationId`	`Id` of the `GradebookColumnCalculation`
Return	`osid.grading.calculation.GradebookColumnCalculation`		the gradebook column calculation
Errors	NOT_FOUND		`gradebookColumnCalculationId` not found
	NULL_ARGUMENT		`gradebookColumnCalculationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradebookColumnCalculationsByIds
Description	Gets a `GradebookColumnCalculationList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the gradebook column calculations specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook column calculations may be omitted from the list.
Parameters	`osid.id.IdList`	`gradebookColumnCalculationIds`	the list of `Ids` to retrieve
Return	`osid.grading.calculation.GradebookColumnCalculationList`		the returned `GradebookColumnCalculation` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`gradeBookColumnCalculationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationsByGenusType
Description	Gets a `GradebookColumnCalculationList` corresponding to the given gradebook column calculation genus `Type` which does not include gradebook column calculations of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known gradebook column calculations or an error results. Otherwise, the returned list may contain only those gradebook column calculations that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnCalculationGenusType`	a gradebook column calculation genus type
Return	`osid.grading.calculation.GradebookColumnCalculationList`		the returned `GradebookColumnCalculation` list
Errors	NULL_ARGUMENT		`gradebookColumnCalculationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationsByParentGenusType
Description	Gets a `GradebookColumnCalculationList` corresponding to the given gradebook column calculation genus `Type` and include any additional column calculations with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known gradebook column calculations or an error results. Otherwise, the returned list may contain only those gradebook column calculations that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnCalculationGenusType`	a gradebook column calculation genus type
Return	`osid.grading.calculation.GradebookColumnCalculationList`		the returned `GradebookColumnCalculation` list
Errors	NULL_ARGUMENT		`gradebookColumnCalculationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationsByRecordType
Description	Gets a `GradebookColumnCalculationList` containing the given gradebook column calculation record `Type.` In plenary mode, the returned list contains all known gradebook column calculations or an error results. Otherwise, the returned list may contain only those gradebook column calculations that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnCalculationRecordType`	a gradebook column calculation record type
Return	`osid.grading.calculation.GradebookColumnCalculationList`		the returned `GradebookColumnCalculation` list
Errors	NULL_ARGUMENT		`gradebookColumnCalculationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationForGradebookColumn
Description	Gets the `GradebookColumnCalculation` mapped to a `GradebookColumn` to which this calculation is applied. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradebookColumnCalculation` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradebookColumnCalculation` and retained for compatibility.
Parameters	`osid.id.Id`	`gradebookColumnId`	`Id` of a `GradebookColumn`
Return	`osid.grading.calculation.GradebookColumnCalculation`		the gradebook column calculation
Errors	NOT_FOUND		`gradebookColumnId` not found
	NULL_ARGUMENT		`gradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradebookColumnCalculationsForGradebookColumns
Description	Gets a `GradebookColumnCalculationList` corresponding to the given gradebook column `Ids` to which this calculation is applied. In plenary mode, the returned list contains all of the gradebook column calculations specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook column calculations may be omitted from the list.
Parameters	`osid.id.IdList`	`gradebookColumnIds`	a list of gradebook column `Ids`
Return	`osid.grading.calculation.GradebookColumnCalculationList`		the returned `GradebookColumnCalculation` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`gradeBookColumnIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculations
Description	Gets all gradebook column calculations. In plenary mode, the returned list contains all known gradebook column calculations or an error results. Otherwise, the returned list may contain only those gradebook column calculations that are accessible through this session.
Return	`osid.grading.calculation.GradebookColumnCalculationList`		a `GradebookColumnCalculationList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.