OSID - osid.grading.GradeEntryLookupSession Service Interface Definition

Interface	osid.grading.GradeEntryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `GradeEntrie` s. 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 entry methods in this session operate, retrieve and pertain to grade entries defined explicitly in the current gradebook. Using an isolated view is useful for managing grade entries with the `GradeEntryAdminSession.` federated gradebook view: All grade entry methods in this session operate, retrieve and pertain to all grade entries defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence. effective grade entry view: All grade entry lookup methods return entries where the current date falls in between the effective dates inclusive. any effective grade entry view: Grade entries of any effective date are returned from methods. Grade entries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `GradeEntry.`
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	canLookupGradeEntries
Description	Tests if this user can perform `GradeEntry` 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	useComparativeGradeEntryView
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	usePlenaryGradeEntryView
Description	A complete view of the `GradeEntry` 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	useEffectiveGradeEntryView
Description	Only grade entries whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveGradeEntryView
Description	All grade entries of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getGradeEntry
Description	Gets the `GradeEntry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradeEntry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradeEntry` and retained for compatibility. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`gradeEntryId`	`Id` of the `GradeEntry`
Return	`osid.grading.GradeEntry`		the grade entry
Errors	NOT_FOUND		`gradeEntryId` not found
	NULL_ARGUMENT		`gradeEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradeEntriesByIds
Description	Gets a `GradeEntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the grade entries 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 grade entries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.IdList`	`gradeEntryIds`	the list of `Ids` to retrieve
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`gradeEntryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByGenusType
Description	Gets a `GradeEntryList` corresponding to the given grade entry genus `Type` which does not include grade entries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.type.Type`	`gradeEntryGenusType`	a grade entry genus type
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`gradeEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByParentGenusType
Description	Gets a `GradeEntryList` corresponding to the given grade entry genus `Type` and include any additional grade entry with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.type.Type`	`gradeEntryGenusType`	a grade entry genus type
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`gradeEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByRecordType
Description	Gets a `GradeEntryList` containing the given grade entry record `Type.` In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.type.Type`	`gradeEntryRecordType`	a grade entry record type
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`gradeEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesOnDate
Description	Gets a `GradeEntryList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForGradebookColumn
Description	Gets a `GradeEntryList` for the gradebook column. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`gradebookColumnId`	a gradebook column `Id`
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`gradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForGradebookColumnOnDate
Description	Gets a `GradeEntryList` for the given gradebook column and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`gradebookColumnId`	a gradebook column `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`gradebookColumnId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForResource
Description	Gets a `GradeEntryList` for the given key key resource. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a key resource `Id`
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForResourceOnDate
Description	Gets a `GradeEntryList` for the given key resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForGradebookColumnAndResource
Description	Gets a `GradeEntryList` for the gradebook column and key resource. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`gradebookColumnId`	a gradebook column `Id`
Parameters	`osid.id.Id`	`resourceId`	a key resource `Id`
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`gradebookColumnId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesForGradebookColumnAndResourceOnDate
Description	Gets a `GradeEntryList` for the given gradebook column, resource, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`gradebookColumnId`	a gradebook column `Id`
	`osid.id.Id`	`resourceId`	a key resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`gradebookColumnId, resource, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByGrader
Description	Gets a `GradeEntryList` for the given grader. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.grading.GradeEntryList`		the returned `GradeEntry` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntries
Description	Gets all grade entries. In plenary mode, the returned list contains all known grade entries or an error results. Otherwise, the returned list may contain only those grade entries that are accessible through this session. In effective mode, grade entries are returned that are currently effective. In any effective mode, effective grade entries and those currently expired are returned.
Return	`osid.grading.GradeEntryList`		a `GradeEntryList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.