OSID - osid.grading.GradeLookupSession Service Interface Definition

Interface	osid.grading.GradeLookupSession
Implements	`osid.OsidSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods for retrieving `Grades` . 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 grade methods in this session operate, retrieve and pertain to grades defined explicitly in the current gradebook Using an isolated view is useful for managing `Grades` with the `GradeAdminSession` . federated grade view: All grade methods in this session operate, retrieve and pertain to all grades defined in this gradebook and any other grades implicitly available in this gradebook through gradebook inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedGradebookView()` and `useIsolatedGradebookView() beha` ve as a radio group and one should be selected before invoking any lookup methods.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupGrades
Description	Tests if this user can perform `Grade` 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	useComparativeGradeView
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	usePlenaryGradeView
Description	A complete view of the `Grade` 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 grades 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	getGrade
Description	Gets the `Grade` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Grade` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Grade and reta` ined for compatibility.
Parameters	`osid.id.Id`	`gradeId`	`Id` of the `Grade`
Return	`osid.grading.Grade`		the grade
Errors	NOT_FOUND		`gradeId` not found
	NULL_ARGUMENT		`gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradesByIds
Description	Gets a `GradeList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the grades 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 `Grades may be omi` tted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`gradeIds`	the list of `Ids` to retrieve
Return	`osid.grading.GradeList`		the returned `Grade` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`gradeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradesByGenusType
Description	Gets a `GradeList` corresponding to the given grade genus `Type` which does not include grades of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known grades or an error results. Otherwise, the returned list may contain only those grades that are accessible through this session.
Parameters	`osid.type.Type`	`gradeGenusType`	a grade genus type
Return	`osid.grading.GradeList`		the returned `Grade` list
Errors	NULL_ARGUMENT		`gradeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradesByParentGenusType
Description	Gets a `GradeList` corresponding to the given grade genus `Type` and include any additional grades with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known grades or an error results. Otherwise, the returned list may contain only those grades that are accessible through this session.
Parameters	`osid.type.Type`	`gradeGenusType`	a grade genus type
Return	`osid.grading.GradeList`		the returned `Grade` list
Errors	NULL_ARGUMENT		`gradeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradesByRecordType
Description	Gets a `GradeList` containing the given grade record `Type` . `In` plenary mode, the returned list contains all known grades or an error results. Otherwise, the returned list may contain only those grades that are accessible through this session.
Parameters	`osid.type.Type`	`gradeRecordType`	a grade record type
Return	`osid.grading.GradeList`		the returned `Grade` list
Errors	NULL_ARGUMENT		`gradeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradesForGradeSystem
Description	Gets a `GradeList` for the given grade system. In plenary mode, the returned list contains all known grades or an error results. Otherwise, the returned list may contain only those grades that are accessible through this session.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Return	`osid.grading.GradeList`		the returned `Grade` list
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGrades
Description	Gets all `Grades` . In plenary mode, the returned list contains all known grades or an error results. Otherwise, the returned list may contain only those grades that are accessible through this session.
Return	`osid.grading.GradeList`		a list of `Grades`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.