OSID - osid.grading.GradeSystemAdminSession Service Interface Definition

Interface	osid.grading.GradeSystemAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `GradeSystems.` 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 `GradeSystem,` a `GradeSystemForm` is requested using `getGradeSystemFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `GradeSystemForm` 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 `GradeSystemForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `GradeSystemForm` corresponds to an attempted transaction. For updates, `GradeSystemForms` are requested to the `GradeSystem` `Id` that is to be updated using `getGradeSystemFormForUpdate().` Similarly, the `GradeSystemForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `GradeSystemForm` can only be used once for a successful update and cannot be reused. The delete operations delete `GradeSystems` To unmap a `GradeSystem` from the current `Gradebook,` the `GradeSystemGradebookAssignmentSession` should be used. These delete operations attempt to remove the `GradeSystem` 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	canCreateGradeSystems
Description	Tests if this user can create `GradeSystems.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `GradeSystem` 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 `GradeSystem` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGradeSystemWithRecordTypes
Description	Tests if this user can create a single `GradeSystem` using the desired record types. While `GradingManager.getGradeSystemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `GradeSystem.` Providing an empty array tests if a `GradeSystem` can be created with no records.
Parameters	`osid.type.Type[]`	`gradeSystemRecordTypes`	array of grade system types
Return	`boolean`		`true` if `GradeSystem` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSystemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemFormForCreate
Description	Gets the grade system form for creating new grade systems. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`gradeSystemRecordTypes`	array of grade system types
Return	`osid.grading.GradeSystemForm`		the grade system form
Errors	NULL_ARGUMENT		`gradeSystemRecordTypes` 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	createGradeSystem
Description	Creates a new `GradeSystem.`
Parameters	`osid.grading.GradeSystemForm`	`gradeSystemForm`	the form for this `GradeSystem`
Return	`osid.grading.GradeSystem`		the new `GradeSystem`
Errors	ILLEGAL_STATE		`gradeSystemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`gradeSystemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeSystemForm` did not originate from `getGradeSystemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGradeSystems
Description	Tests if this user can update `GradeSystems.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `GradeSystem` 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 `GradeSystem` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemFormForUpdate
Description	Gets the grade system form for updating an existing grade system. A new grade system form should be requested for each update transaction.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the `GradeSystem`
Return	`osid.grading.GradeSystemForm`		the grade system form
Errors	NOT_FOUND		`gradeSystemId` is not found
	NULL_ARGUMENT		`gradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateGradeSystem
Description	Updates an existing grade system.
Parameters	`osid.grading.GradeSystemForm`	`gradeSystemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`gradeSystemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`gradeSystemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeSystemForm` did not originate from `getGradeSystemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGradeSystems
Description	Tests if this user can delete grade systems. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `GradeSystem` 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 `GradeSystem` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteGradeSystem
Description	Deletes a `GradeSystem.`
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of the `GradeSystem` to remove
Errors	NOT_FOUND		`gradeSystemId` not found
	NULL_ARGUMENT		`gradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageGradeSystemAliases
Description	Tests if this user can manage `Id` aliases for `GradeSystems.` 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 `GradeSystem` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasGradeSystem
Description	Adds an `Id` to a `GradeSystem` for the purpose of creating compatibility. The primary `Id` of the `GradeSystem` 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, it is reassigned to the given grade system `Id.`
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`gradeSystemId` not found
	NULL_ARGUMENT		`gradeSystemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGrades
Description	Tests if this user can create `Grade` s for a `GradeSystem.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `GradeSystem` 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.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Return	`boolean`		`false` if `Grade` creation is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	canCreateGradeWithRecordTypes
Description	Tests if this user can create a single `Grade` using the desired record types. While `GradingManager.getGradeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Grade.` Providing an empty array tests if a `Grade` can be created with no records.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Parameters	`osid.type.Type[]`	`gradeRecordTypes`	array of grade recod types
Return	`boolean`		`true` if `Grade` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSystemId` or `gradeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeFormForCreate
Description	Gets the grade form for creating new grades. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Parameters	`osid.type.Type[]`	`gradeRecordTypes`	array of grade recod types
Return	`osid.grading.GradeForm`		the grade form
Errors	NOT_FOUND		`gradeSystemId` is not found
	NULL_ARGUMENT		`gradeSystemId` or `gradeRecordTypes` 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	createGrade
Description	Creates a new `Grade.`
Parameters	`osid.grading.GradeForm`	`gradeForm`	the form for this `Grade`
Return	`osid.grading.Grade`		the new `Grade`
Errors	ILLEGAL_STATE		`gradeForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`gradeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeForm` did not originate from `getGradeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateGrades
Description	Tests if this user can update `Grades.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Grade` 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.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Return	`boolean`		`false` if `Grade` modification is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeFormForUpdate
Description	Gets the grade form for updating an existing grade. A new grade form should be requested for each update transaction.
Parameters	`osid.id.Id`	`gradeId`	the `Id` of the `Grade`
Return	`osid.grading.GradeForm`		the grade form
Errors	NOT_FOUND		`gradeId` is not found
	NULL_ARGUMENT		`gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateGrade
Description	Updates an existing grade.
Parameters	`osid.grading.GradeForm`	`gradeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`gradeForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`gradeId` or `gradeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeForm` did not originate from `getGradeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteGrades
Description	Tests if this user can delete grades. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Grade` 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.
Parameters	`osid.id.Id`	`gradeSystemId`	the `Id` of a `GradeSystem`
Return	`boolean`		`false` if `Grade` deletion is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	deleteGrade
Description	Deletes a `Grade.`
Parameters	`osid.id.Id`	`gradeId`	the `Id` of the `Grade` to remove
Errors	NOT_FOUND		`gradeId` not found
	NULL_ARGUMENT		`gradeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageGradeAliases
Description	Tests if this user can manage `Id` aliases for `Grades.` 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 `Grade` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasGrade
Description	Adds an `Id` to a `Grade` for the purpose of creating compatibility. The primary `Id` of the `Grade` 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, it is reassigned to the given grade `Id.`
Parameters	`osid.id.Id`	`gradeId`	the `Id` of a `Grade`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`gradeId` not found
	NULL_ARGUMENT		`gradeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.