OSID - osid.grading.GradeEntryGradebookSession Service Interface Definition

Interface	osid.grading.GradeEntryGradebookSession
Implements	`osid.OsidSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods to retrieve `GradeEntry` to `Gradebook` mappings. A `GradeEntry` may appear in multiple `Gradebooks` . Each `Gradebook` may have its own authorizations governing who is allowed to look at it. This lookup session defines two views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	useComparativeGradebookView
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	usePlenaryGradebookView
Description	A complete view of the `GradebookColumn` and `Gradebook` 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	canLookupGradeEntryGradebookMappings
Description	Tests if this user can perform lookups of gradebook/grade entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryIdsByGradebook
Description	Gets the list of `GradeEntry` `Ids` associated with a `Gradebook` .
Parameters	`osid.id.Id`	`gradebookId`	`Id` of the `Gradebook`
Return	`osid.id.IdList`		list of related grade entry `Ids`
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByGradebook
Description	Gets the list of grade entries associated with a `Gradebook` .
Parameters	`osid.id.Id`	`gradebookId`	`Id` of the `Gradebook`
Return	`osid.grading.GradeEntryList`		list of related grade entries
Errors	NOT_FOUND		`gradebookId` is not found
	NULL_ARGUMENT		`gradebookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryIdsByGradebooks
Description	Gets the list of `GradeEntry Ids` corresponding to a list of `Gradebooks` .
Parameters	`osid.id.IdList`	`gradebookIds`	list of gradebook `Ids`
Return	`osid.id.IdList`		list of grade entry `Ids`
Errors	NULL_ARGUMENT		`gradebookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByGradebooks
Description	Gets the list of grade entries corresponding to a list of `Gradebooks` .
Parameters	`osid.id.IdList`	`gradebookIds`	list of gradebook `Ids`
Return	`osid.grading.GradeEntryList`		list of grade entries
Errors	NULL_ARGUMENT		`gradebookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookIdsByGradeEntry
Description	Gets the list of `Gradebook` `Ids` mapped to a `GradeEntry` .
Parameters	`osid.id.Id`	`gradeEntryId`	`Id` of a `GradeEntry`
Return	`osid.id.IdList`		list of gradebook `Ids`
Errors	NOT_FOUND		`gradeEntryId` is not found
	NULL_ARGUMENT		`gradeEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebooksByGradeEntry
Description	Gets the list of `Gradebooks` mapped to a `GradeEntry` .
Parameters	`osid.id.Id`	`gradeEntryId`	`Id` of a `GradeEntry`
Return	`osid.grading.GradebookList`		list of gradebooks
Errors	NOT_FOUND		`gradeEntryId` is not found
	NULL_ARGUMENT		`gradeEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.