OSID - osid.grading.GradebookColumnSmartGradebookSession Service Interface Definition

Interface	osid.grading.GradebookColumnSmartGradebookSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `GradebookColumnQuery` can be retrieved from this session and mapped to this `Gradebook` to create a virtual collection of `GradebookColumns.` The entries may be sequenced using the `GradebookColumnSearchOrder` from this session. This `Gradebook` has a default query that matches any gradebook column and a default search order that specifies no sequencing. The queries may be examined using a `GradebookColumnQueryInspector.` The query may be modified by converting the inspector back to a `GradebookColumnQuery.`
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	canManageSmartGradebooks
Description	Tests if this user can manage smart gradebooks. 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 smart operations.
Return	`boolean`		`false` if smart gradebook methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnQuery
Description	Gets a gradebook column query.
Return	`osid.grading.GradebookColumnQuery`		the gradebook column query
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSearchOrder
Description	Gets a gradebook column search order.
Return	`osid.grading.GradebookColumnSearchOrder`		the gradebook column search order
Compliance	`mandatory`		This method must be implemented.
Method	applyGradebookColumnQuery
Description	Applies a gradebook column query to this gradebook.
Parameters	`osid.grading.GradebookColumnQuery`	`gradebookColumnQuery`	the gradebook column query
Errors	NULL_ARGUMENT		`gradebookColumnQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradebookColumnQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectGradebookColumnQuery
Description	Gets a gradebook column query inspector for this gradebook.
Return	`osid.grading.GradebookColumnQueryInspector`		the gradebook column query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyGradebookColumnSequencing
Description	Applies a gradebook column search order to this gradebook.
Parameters	`osid.grading.GradebookColumnSearchOrder`	`gradebookColumnSearchOrder`	the gradebook column search order
Errors	NULL_ARGUMENT		`gradebookColumnSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradebookColumnSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnQueryFromInspector
Description	Gets a gradebook column query from an inspector.
Parameters	`osid.grading.GradebookColumnQuery`	`gradebookColumnQueryInspector`	a gradebook column query inspector
Return	`osid.grading.GradebookColumnQuery`		the gradebook column query
Errors	NULL_ARGUMENT		`gradebookColumnQueryInspector` is `null`
Errors	UNSUPPORTED		`gradebookColumnQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.