OSID - osid.grading.transform.GradeSystemTransformAdminSession Service Interface Definition

Interface	osid.grading.transform.GradeSystemTransformAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `GradeSystemTransforms.` 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 `GradeSystemTransform,` a `GradeSystemTransformForm` is requested using `getGradeSystemTransformFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `GradeSystemTransformForm` 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 `GradeSystemTransformForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `GradeSystemTransformForm` corresponds to an attempted transaction. For updates, `GradeSystemTransformForms` are requested to the `GradeSystemTransformForm` `Id` that is to be updated using `getGradeSystemTransformFormForUpdate().` Similarly, the `GradeSystemTransformForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `GradeSystemTransformForm` can only be used once for a successful update and cannot be reused. The delete operations delete `GradeSystemTransforms.` 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	canCreateGradeSystemTransforms
Description	Tests if this user can create `GradeSystemTransforms.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `GradeSystemTransform` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `GradeSystemTransform` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGradeSystemTransformWithRecordTypes
Description	Tests if this user can create a single `GradeSystemTransform` using the desired record types. While `GradingTransformManager.getGradeSystemTransformRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `GradeSystemTransform.` Providing an empty array tests if a `GradeSystemTransform` can be created with no records.
Parameters	`osid.type.Type[]`	`gradeSystemTransformRecordTypes`	array of grade system transform record types
Return	`boolean`		`true` if `GradeSystemTransform` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSystemTransformRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformFormForCreate
Description	Gets the grade system transform form for creating new grade system transforms. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`sourceGradeSystemId`	the `Id` for the source `GradeSystem`
	`osid.id.Id`	`targetGradeSystemId`	the `Id` for the source `GradeSystem`
	`osid.type.Type[]`	`gradeSystemTransformRecordTypes`	array of grade system transform record types
Return	`osid.grading.transform.GradeSystemTransformForm`		the grade system transform form
Errors	NOT_FOUND		`sourceHradeSystemId` or `targetGradeSystemId` not found
	NULL_ARGUMENT		`sourceGradeSystemId, targetGradeSystemId,` `gradeSystemTransformRecordTypes` 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	createGradeSystemTransform
Description	Creates a new `GradeSystemTransform.`
Parameters	`osid.grading.transform.GradeSystemTransformForm`	`gradeSystemTransformForm`	the form for this `GradeSystemTransform`
Return	`osid.grading.transform.GradeSystemTransform`		the new `GradeSystemTransform`
Errors	ILLEGAL_STATE		`gradeSystemTransformForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`gradeSystemTransformForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeSystemTransformForm` did not originate from `getGradeSystemTransformFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGradeSystemTransforms
Description	Tests if this user can update `GradeSystemTransforms.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `GradeSystemTransform` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `GradeSystemTransform` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformFormForUpdate
Description	Gets the grade system form for updating an existing grade system transform. A new grade system transform form should be requested for each update transaction.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of the `GradeSystemTransform`
Return	`osid.grading.transform.GradeSystemTransformForm`		the grade system transform form
Errors	NOT_FOUND		`gradeSystemTransformId` is not found
	NULL_ARGUMENT		`gradeSystemTransformId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateGradeSystemTransform
Description	Updates an existing grade system transform.
Parameters	`osid.grading.transform.GradeSystemTransformForm`	`gradeSystemTransformForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`gradeSystemTransformForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`gradeSystemTransformForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeSystemTransformForm` did not originate from `getGradeSystemTransformFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGradeSystemTransforms
Description	Tests if this user can delete grade system transforms. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `GradeSystemTransform` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `GradeSystemTransform` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteGradeSystemTransform
Description	Deletes a `GradeSystemTransform.`
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of the `GradeSystemTransform` to remove
Errors	NOT_FOUND		`gradeSystemTransformId` not found
	NULL_ARGUMENT		`gradeSystemTransformId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageGradeSystemTransformAliases
Description	Tests if this user can manage `Id` aliases for `GradeSystemTransforms.` 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 `GradeSystemTransform` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasGradeSystemTransform
Description	Adds an `Id` to a `GradeSystemTransform` for the purpose of creating compatibility. The primary `Id` of the `GradeSystemTransform` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another grade system transform, it is reassigned to the given grade system transform `Id.`
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of a `GradeSystemTransform`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`gradeSystemTransformId` not found
	NULL_ARGUMENT		`gradeSystemTransformId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addGradeMap
Description	Adds a direct grade mapping to a transform.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of a `GradeSystemTransform`
	`osid.id.Id`	`sourceGradeId`	the source grade `Id`
	`osid.id.Id`	`targetGradeId`	the target grade `Id`
Errors	ALREADY_EXISTS		`sourceGradeId` is already mapped
	NOT_FOUND		`gradeSystemTransformId, sourceGradeId` or `targetGradeId` not found
	NULL_ARGUMENT		`gradeSystemTransformId, sourceGradeId` or `targetGradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeGradeMap
Description	Removes a direct grade mapping from a transform.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	the `Id` of a `GradeSystemTransform`
Parameters	`osid.id.Id`	`sourceGradeId`	the source grade `Id`
Errors	NOT_FOUND		no mapping in `gradeSystemTransformId` for `sourceGradeId`
	NULL_ARGUMENT		`gradeSystemTransformId` or `sourceGradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.