OSID - osid.assessment.AssessmentTakenAdminSession Service Interface Definition

Interface	osid.assessment.AssessmentTakenAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `AssessmentsTaken.` 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 an `AssessmentTaken,` an `AssessmentTakenForm` is requested using `getAssessmentTakenFormForCreate()` specifying the assessment offered and desired record `Types` or none if no record `Types` are needed. The returned `AssessmentTakenForm` 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 `AssessmentTakenForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AssessmentTakenForm` corresponds to an attempted transaction. For updates, `AssessmentTakenForms` are requested to the `AssessmentTaken` `Id` that is to be updated using `getAssessmentTakenFormForUpdate().` Similarly, the `AssessmentTakenForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AssessmentTakenForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AssessmentsTaken.` To unmap an `AssessmentTakenForm` from the current `Bank,` the `AssessmentTakenFormBankAssignmentSession` should be used. These delete operations attempt to remove the `AssessmentTakenForm` itself thus removing it from all known `Bank` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the `Bank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentsTaken
Description	Tests if this user can create `AssessmentTaken` objects. A return of true does not guarantee successful authoriization. A return of false indicates that it is known creating an `AssessmentTaken` 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 `AssessmentTaken` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentTakenWithRecordTypes
Description	Tests if this user can create a single `AssessmentTaken` using the desired record types. While `AssessmentManager.getAssessmentTakenRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AssessmentTaken.` Providing an empty array tests if an `AssessmentTaken` can be created with no records.
Parameters	`osid.type.Type[]`	`assessmentTakenRecordTypes`	array of assessment taken record types
Return	`boolean`		`true` if `AssessmentTaken` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentTakenRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenFormForCreate
Description	Gets the assessment taken form for creating new assessments taken. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`assessmentOfferedId`	the `Id` of the related `AssessmentOffered`
Parameters	`osid.type.Type[]`	`assessmentTakenRecordTypes`	array of assessment taken record types to be included in the create operation or an empty list if none
Return	`osid.assessment.AssessmentTakenForm`		the assessment taken form
Errors	NOT_FOUND		`assessmentOfferedId` is not found
	NULL_ARGUMENT		`assessmentOfferedId` or `assessmentTakenRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createAssessmentTaken
Description	Creates a new `AssessmentTaken.`
Parameters	`osid.assessment.AssessmentTakenForm`	`assessmentTakenForm`	the form for this `AssessmentTaken`
Return	`osid.assessment.AssessmentTaken`		the new `AssessmentTaken`
Errors	ILLEGAL_STATE		`assessmentTakenForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`assessmentTakenForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentOfferedForm` did not originate from `getAssessmentTakenFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAssessmentsTaken
Description	Tests if this user can update `AssessmentTaken` objects. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AssessmentTaken` 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 `AssessmentTaken` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenFormForUpdate
Description	Gets the assessment taken form for updating an existing assessment taken. A new assessment taken form should be requested for each update transaction.
Parameters	`osid.id.Id`	`assessmentTakenId`	the `Id` of the `AssessmentTaken`
Return	`osid.assessment.AssessmentTakenForm`		the assessment taken form
Errors	NOT_FOUND		`assessmentTakenId` is not found
	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	updateAssessmentTaken
Description	Updates an existing assessment taken.
Parameters	`osid.assessment.AssessmentTakenForm`	`assessmentTakenForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`assessmentTakenForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`assessmentTakenForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentOfferedForm` did not originate from `getAssessmentTakenFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssessmentsTaken
Description	Tests if this user can delete `AssessmentsTaken.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AssessmentTaken` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer a delete operations to unauthorized users.
Return	`boolean`		`false` if `AssessmentTaken` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAssessmentTaken
Description	Deletes an `AssessmentTaken.`
Parameters	`osid.id.Id`	`assessmentTakenId`	the `Id` of the `AssessmentTaken` to remove
Errors	NOT_FOUND		`assessmentTakenId` not found
	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	canManageAssessmentTakenAliases
Description	Tests if this user can manage `Id` aliases for `AssessmentsTaken.` 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 `AssessmentTaken` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAssessmentTaken
Description	Adds an `Id` to an `AssessmentTaken` for the purpose of creating compatibility. The primary `Id` of the `AssessmentTaken` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another assessment taken, it is reassigned to the given assessment taken `Id.`
Parameters	`osid.id.Id`	`assessmentTakenId`	the `Id` of an `AssessmentTaken`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`assessmentTakenId` not found
	NULL_ARGUMENT		`assessmentTakenId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.