OSID - osid.grading.GradebookColumnLookupSession Service Interface Definition

Interface	osid.grading.GradebookColumnLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `GradebookColumns` . 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 methods in this session operate, retrieve and pertain to gradebook columns defined explicitly in the current gradebook. Using an isolated view is useful for managing gradebook columns with the `GradebookColumnAdminSession.` federated gradebook view: All gradebook column methods in this session operate, retrieve and pertain to all gradebook columns defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence. Gradebook columns may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `GradebookColumn.`
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	canLookupGradebookColumns
Description	Tests if this user can perform `GradebookColumn` 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	useComparativeGradebookColumnView
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	usePlenaryGradebookColumnView
Description	A complete view of the `GradebookColumn` 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 columns 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	getGradebookColumn
Description	Gets the `GradebookColumn` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradebookColumn` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradebookColumn` and retained for compatibility.
Parameters	`osid.id.Id`	`gradebookColumnId`	`Id` of the `GradebookColumn`
Return	`osid.grading.GradebookColumn`		the gradebook column
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	getGradebookColumnsByIds
Description	Gets a `GradebookColumnList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the gradebook columns 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 columns may be omitted from the list.
Parameters	`osid.id.IdList`	`gradebookColumnIds`	the list of `Ids` to retrieve
Return	`osid.grading.GradebookColumnList`		the returned `GradebookColumn` 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	getGradebookColumnsByGenusType
Description	Gets a `GradebookColumnList` corresponding to the given gradebook column genus `Type` which does not include gradebook columns of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnGenusType`	a gradebook column genus type
Return	`osid.grading.GradebookColumnList`		the returned `GradebookColumn` list
Errors	NULL_ARGUMENT		`gradebookColumnGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnsByParentGenusType
Description	Gets a `GradebookColumnList` corresponding to the given gradebook column genus `Type` and include any additional columns with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnGenusType`	a gradebook column genus type
Return	`osid.grading.GradebookColumnList`		the returned `GradebookColumn` list
Errors	NULL_ARGUMENT		`gradebookColumnGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnsByRecordType
Description	Gets a `GradebookColumnList` containing the given gradebook column record `Type.` In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.
Parameters	`osid.type.Type`	`gradebookColumnRecordType`	a gradebook column record type
Return	`osid.grading.GradebookColumnList`		the returned `GradebookColumn` list
Errors	NULL_ARGUMENT		`gradebookColumnRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumns
Description	Gets all gradebook columns. In plenary mode, the returned list contains all known gradebook columns or an error results. Otherwise, the returned list may contain only those gradebook columns that are accessible through this session.
Return	`osid.grading.GradebookColumnList`		a `GradebookColumn`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummary
Description	Tests if a summary entry is available.
Return	`boolean`		`true` if a summary entry is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSummary
Description	Gets the `GradebookColumnSummary` for summary results.
Parameters	`osid.id.Id`	`gradebookColumnId`	`Id` of the `GradebookColumn`
Return	`osid.grading.GradebookColumnSummary`		the gradebook column summary
Errors	NOT_FOUND		`gradebookColumnId` is not found
	NULL_ARGUMENT		`gradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNIMPLEMENTED		`hasSummary()` is `false`
Compliance	`mandatory`		This method is must be implemented.