OSID - osid.grading.calculation.GradebookColumnCalculationAdminSession Service Interface Definition

Interface	osid.grading.calculation.GradebookColumnCalculationAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `GradebookColumnCalculations.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `GradebookColumnCalculation,` a `GradebookColumnCalculationForm` is requested using `getGradebookColumnCalculationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `GradebookColumnCalculationForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `GradebookColumnCalculationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `GradebookColumnCalculationForm` corresponds to an attempted transaction. For updates, `GradebookColumnCalculationForms` are requested to the `GradebookColumnCalculation` `Id` that is to be updated using `getGradebookColumnCalculationFormForUpdate().` Similarly, the `GradebookColumnCalculationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `GradebookColumnCalculationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `GradebookColumnCalculations.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateGradebookColumnCalculations
Description	Tests if this user can create gradebook column calculationss. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a gradebook column will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `GradebookColumnCalculation` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGradebookColumnCalculationWithRecordTypes
Description	Tests if this user can create a single `GradebookColumnCalculation` using the desired record types. While `GradingCalculationManager.getGradebookColumnCalculationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `GradebookColumnCalculation.` Providing an empty array tests if a `GradebookColumnCalculation` can be created with no records.
Parameters	`osid.type.Type[]`	`gradebookColumnRecordCalculationTypes`	array of gradebook column calculation record types
Return	`boolean`		`true` if `GradebookColumnCalculation` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookColumnRecordCalculationTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationFormForCreate
Description	Gets the gradebook column calculation form for creating new gradebook columns. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`gradebookColumnId`	the `Id` for the `GradebookColumn`
Parameters	`osid.type.Type[]`	`gradebookColumnRecordCalculationTypes`	array of gradebook column calculation record types
Return	`osid.grading.calculation.GradebookColumnCalculationForm`		the gradebook column calculation form
Errors	ALREADY_EXISTS		`gradebookColumnId` already has a calculation
	NOT_FOUND		`gradebookColumnId` is not found
	NULL_ARGUMENT		`gradebokColumnId` or `gradebookColumnRecordCalculationTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createGradebookColumnCalculation
Description	Creates a new `GradebookColumnCalculation.`
Parameters	`osid.grading.calculation.GradebookColumnCalculationForm`	`gradebookColumnCalculationForm`	the form containing the elements to be updated
Return	`osid.grading.calculation.GradebookColumnCalculation`		the new `GradebookColumnCalculation`
Errors	ILLEGAL_STATE		`gradebookColumnCalculationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`gradebookColumnCalculationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookColumnCalculationForm` did not originate from `getGradebookColumnCalculationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGradebookColumnCalculations
Description	Tests if this user can update gradebook column calculations. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `GradebookColumnCalculation` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if gradebook column calculation modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnCalculationFormForUpdate
Description	Gets the gradebook column calculation form for updating an existing gradebook column. A new gradebook column form should be requested for each update transaction.
Parameters	`osid.id.Id`	`gradebookColumnCalculationId`	the `Id` of the `GradebookColumnCalculation`
Return	`osid.grading.calculation.GradebookColumnCalculationForm`		the gradebook column calculation form
Errors	NOT_FOUND		`gradebookColumnCalculationId` is not found
	NULL_ARGUMENT		`gradebookColumnCalculationId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateGradebookColumnCalculation
Description	Updates an existing gradebook column calculation.
Parameters	`osid.grading.calculation.GradebookColumnCalculationForm`	`gradebookColumnCalculationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`gradebookColumnCalculationForm` already used in a update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`gradebookColumnCalculationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookColumnCalculationForm` did not originate from `getGradebookColumnCalculationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGradebookColumnCalculations
Description	Tests if this user can delete gradebook column calculations. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `GradebookColumnCalculation` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `GradebookColumnCalculation` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteGradebookColumnCalculation
Description	Deletes the `GradebookColumnCalculation` identified by the given `Id.`
Parameters	`osid.id.Id`	`gradebookColumnCalculationId`	the `Id` of the `GradebookColumnCalculation` to delete
Errors	NOT_FOUND		a `GradebookColumnCalculation` was not found identified by the given `Id`
	NULL_ARGUMENT		`gradebookColumnCalculationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.