OSID - osid.grading.GradebookColumnAdminSession Service Interface Definition

Interface	osid.grading.GradebookColumnAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.grading.batch.GradebookColumnBatchAdminSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session creates, updates, and deletes `GradebookColumns`. 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 `GradebookColumn`, a `GradebookColumnForm` is requested using `getGradebookColumnFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `GradebookColumnForm` 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 `GradebookColumnForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `GradebookColumnForm` corresponds to an attempted transaction. For updates, `GradebookColumnForms` are requested to the `GradebookColumn` `Id` that is to be updated using `getGradebookColumnFormForUpdate()`. Similarly, the `GradebookColumnForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `GradebookColumnForm` can only be used once for a successful update and cannot be reused. The delete operations delete `GradebookColumns` To unmap a `GradebookColumn` from the current `Gradebook`, the `GradebookColumnGradebookAssignmentSession` should be used. These delete operations attempt to remove the `GradebookColumnForm` itself thus removing it from all known `Gradebook` catalogs. 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	canCreateGradebookColumns
Description	Tests if this user can create gradebook columns. 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 `GradebookColumn` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGradebookColumnWithRecordTypes
Description	Tests if this user can create a single `GradebookColumn` using the desired record types. While `GradingManager.getGradebookColumnRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `GradebookColumn`. Providing an empty array tests if a `GradebookColumn` can be created with no records.
Parameters	`osid.type.Type[]`	`gradebookColumnRecordTypes`	array of gradebook column record types
Return	`boolean`		`true` if `GradebookColumn` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookColumnRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnFormForCreate
Description	Gets the gradebook column form for creating new gradebook columns. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`gradebookColumnRecordTypes`	array of gradebook column record types
Return	`osid.grading.GradebookColumnForm`		the gradebook column form
Errors	NULL_ARGUMENT		`gradebookColumnRecordTypes` 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	createGradebookColumn
Description	Creates a new `GradebookColumn`.
Parameters	`osid.grading.GradebookColumnForm`	`gradebookColumnForm`	the form for this `GradebookColumn`
Return	`osid.grading.GradebookColumn`		the new `GradebookColumn`
Errors	ILLEGAL_STATE		`gradebookColumnForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`gradebookColumnForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookColumnForm` did not originate from `getGradebookColumnFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGradebookColumns
Description	Tests if this user can update gradebook columns. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `GradebookColumn` 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 modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnFormForUpdate
Description	Gets the gradebook column form for updating an existing gradebook column. A new gradebook column form should be requested for each update transaction.
Parameters	`osid.id.Id`	`gradebookColumnId`	the `Id` of the `GradebookColumn`
Return	`osid.grading.GradebookColumnForm`		the gradebook column form
Errors	NOT_FOUND		`gradebookColumnId` is not found
	NULL_ARGUMENT		`gradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateGradebookColumn
Description	Updates an existing gradebook column.
Parameters	`osid.grading.GradebookColumnForm`	`gradebookColumnForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`gradebookColumnForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`gradebookColumnForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradebookColumnForm` did not originate from `getGradebookColumnFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	sequenceGradebookColumns
Description	Resequences the gradebook columns.
Parameters	`osid.id.IdList`	`gradebookColumnIds`	the `Ids` of the `GradebookColumns`
Errors	NULL_ARGUMENT		`gradebookColumnIdList` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveGradebookColumn
Description	Moves a gradebook column in front of another.
Parameters	`osid.id.Id`	`frontGradebookColumnId`	the `Id` of a `GradebookColumn`
Parameters	`osid.id.Id`	`backGradebookColumnId`	the `Id` of a `GradebookColumn`
Errors	NOT_FOUND		`frontGradebookColumnId or backGradebookColumnId` is not found
	NULL_ARGUMENT		`frontGradebookColumnId or backGradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	copyGradebookColumnEntries
Description	Copies gradebook column entries from one column to another. If the target grade column grade system differs from the source, the grades in the entries are transformed to the new grade system.
Parameters	`osid.id.Id`	`sourceGradebookColumnId`	the `Id` of a `GradebookColumn`
Parameters	`osid.id.Id`	`targetGradebookColumnId`	the `Id` of a `GradebookColumn`
Errors	NOT_FOUND		`sourceGradebookColumnId ortargetGradebookColumnId` is not found
	NULL_ARGUMENT		`sourceGradebookColumnId targetGradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGradebookColumns
Description	Tests if this user can delete gradebook columns. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `GradebookColumn` 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 `GradebookColumn` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteGradebookColumn
Description	Deletes the `GradebookColumn` identified by the given `Id`.
Parameters	`osid.id.Id`	`gradebookColumnId`	the `Id` of the `GradebookColumn` to delete
Errors	NOT_FOUND		a `GradebookColumn` was not found identified by the given `Id`
	NULL_ARGUMENT		`gradebookColumnId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageGradebookColumnAliases
Description	Tests if this user can manage `Id` aliases for `GradebookColumns`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `GradebookColumn` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasGradebookColumn
Description	Adds an `Id` to a `GradebookColumn` for the purpose of creating compatibility. The primary `Id` of the `GradebookColumn` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another gradebook column, it is reassigned to the given gradebook column `Id`.
Parameters	`osid.id.Id`	`gradebookColumnId`	the `Id` of a `GradebookColumn`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`gradebookColumnId` not found
	NULL_ARGUMENT		`gradebookColumnId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.