OSID - osid.grading.GradeSystemLookupSession Service Interface Definition

Interface	osid.grading.GradeSystemLookupSession
Implements	`osid.OsidSession`
Description	The session defines methods for retrieving `Grades` and `GradeSystems.` A Grade represents a qualified ranking defined in some grade system. Two views are defined in this session: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition federated gradebook view: lookups include grade systems from this gradebook and other gradebooks which are children of this gradebook in the gradebook hierarchy isolated gradebook view: lookups include only those grade systems defined in this gradebook Grades and grade systems may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the object.
Method	getGradebookId
Description	Gets the `GradeSystem` `Id` associated with this session.
Return	`osid.id.Id`		the `GradeSystem 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	canLookupGradeSystems
Description	Tests if this user can perform `GradeSystem` 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	useComparativeGradeSystemView
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	usePlenaryGradeSystemView
Description	A complete view of the `GradeSystem` 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 grade entries 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	getGradeSystem
Description	Gets the `GradeSystem` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradeSystem` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradeSystem` and retained for compatibility.
Parameters	`osid.id.Id`	`gradeSystemId`	`Id` of the `GradeSystem`
Return	`osid.grading.GradeSystem`		the grade system
Errors	NOT_FOUND		`gradeSystemId` not found
	NULL_ARGUMENT		`gradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradeSystemByGrade
Description	Gets the `GradeSystem` by a `Grade` `Id.`
Parameters	`osid.id.Id`	`gradeId`	`Id` of a `Grade`
Return	`osid.grading.GradeSystem`		the grade system
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	getGradeSystemsByIds
Description	Gets a `GradeSystemList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the systems 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 `GradeSystems` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`gradeSystemIds`	the list of `Ids` to retrieve
Return	`osid.grading.GradeSystemList`		the returned `GradeSystem` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`gradeSystemIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemsByGenusType
Description	Gets a `GradeSystemList` corresponding to the given grade system genus `Type` which does not include systems of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemGenusType`	a grade system genus type
Return	`osid.grading.GradeSystemList`		the returned `GradeSystem` list
Errors	NULL_ARGUMENT		`gradeSystemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemsByParentGenusType
Description	Gets a `GradeSystemList` corresponding to the given grade system genus `Type` and include any additional systems with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemGenusType`	a grade system genus type
Return	`osid.grading.GradeSystemList`		the returned `GradeSystem` list
Errors	NULL_ARGUMENT		`gradeSystemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemsByRecordType
Description	Gets a `GradeSystemList` containing the given grade record `Type.` In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemRecordType`	a grade system record type
Return	`osid.grading.GradeSystemList`		the returned `GradeSystem` list
Errors	NULL_ARGUMENT		`gradeSystemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystems
Description	Gets all `GradeSystems.` In plenary mode, the returned list contains all known grade systems or an error results. Otherwise, the returned list may contain only those grade systems that are accessible through this session.
Return	`osid.grading.GradeSystemList`		a `GradeSystemList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.