OSID - osid.assessment.authoring.AssessmentPartAdminSession Service Interface Definition

Interface	osid.assessment.authoring.AssessmentPartAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `AssessmentParts.` 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 `AssessmentPart,` an `AssessmentPartForm` is requested using `getAssessmentPartFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AssessmentPartForm` 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 `AssessmentPartForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AssessmentPartForm` corresponds to an attempted transaction. For updates, `AssessmentPartForms` are requested to the `AssessmentPart` `Id` that is to be updated using `getAssessmentPartFormForUpdate().` Similarly, the `AssessmentPartForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AssessmentPartForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AssessmentParts.` 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
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentParts
Description	Tests if this user can create assessment parts. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to unauthorized users.
Return	`boolean`		`false` if `AssessmentPart` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentPartWithRecordTypes
Description	Tests if this user can create a single `AssessmentPart` using the desired record types. While `AssessmentAuthoringManager.getAssessmentPartRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AssessmentPart.` Providing an empty array tests if an `AssessmentPart` can be created with no records.
Parameters	`osid.type.Type[]`	`assessmentPartRecordTypes`	array of assessment part record types
Return	`boolean`		`true` if `AssessmentPart` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentPartRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartFormForCreateForAssessment
Description	Gets the assessment part form for creating new assessment parts for an assessment. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`osid.type.Type[]`	`assessmentPartRecordTypes`	array of assessment part record types to be included in the create operation or an empty list if none
Return	`osid.assessment.authoring.AssessmentPartForm`		the assessment part form
Errors	NOT_FOUND		`assessmentId` is not found
	NULL_ARGUMENT		`assessmentId` or `assessmentPartRecordTypes` 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	createAssessmentPartForAssessment
Description	Creates a new assessment part.
Parameters	`osid.assessment.authoring.AssessmentPartForm`	`assessmentPartForm`	assessment part form
Return	`osid.assessment.authoring.AssessmentPart`		the new part
Errors	ILLEGAL_STATE		`assessmentPartForm` already used in a create transaction
	INVALID_ARGUMENT		`assessmentPartForm` is invalid
	NULL_ARGUMENT		`assessmentPartForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentPartForm` did not originate from `getAssessmentPartFormForCreateForAssessment()`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartFormForCreateForAssessmentPart
Description	Gets the assessment part form for creating new assessment parts under another assessment part. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`osid.type.Type[]`	`assessmentPartRecordTypes`	array of assessment part record types to be included in the create operation or an empty list if none
Return	`osid.assessment.authoring.AssessmentPartForm`		the assessment part form
Errors	NOT_FOUND		`assessmentPartId` is not found
	NULL_ARGUMENT		`assessmentPartId` or `assessmentPartRecordTypes` 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	createAssessmentPartForAssessmentPart
Description	Creates a new assessment part.
Parameters	`osid.assessment.authoring.AssessmentPartForm`	`assessmentPartForm`	assessment part form
Return	`osid.assessment.authoring.AssessmentPart`		the new part
Errors	ILLEGAL_STATE		`assessmentPartForm` already used in a create transaction
	INVALID_ARGUMENT		`assessmentPartForm` is invalid
	NULL_ARGUMENT		`assessmentPartForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentPartForm` did not originate from `getAssessmentPartFormForCreateForAssessmentPart()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAssessmentParts
Description	Tests if this user can update `AssessmentParts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AssessmentPart` 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 assessment part modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartFormForUpdate
Description	Gets the assessment part form for updating an existing assessment part. A new assessment part form should be requested for each update transaction.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart`
Return	`osid.assessment.authoring.AssessmentPartForm`		the assessment part form
Errors	NOT_FOUND		`assessmentPartId` is not found
	NULL_ARGUMENT		`assessmentPartId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	updateAssessmentPart
Description	Updates an existing assessment part.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart`
Parameters	`osid.assessment.authoring.AssessmentPartForm`	`assessmentPartForm`	part form
Errors	NOT_FOUND		`assessmentPartId` not found
	NULL_ARGUMENT		`assessmentPartId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`assessmentPartForm` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssessmentParts
Description	Tests if this user can delete `AssessmentParts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AssessmentPart` 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 `AssessmentPart` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAssessmentPart
Description	Removes an asessment part and all mapped items.
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of the `AssessmentPart`
Errors	NOT_FOUND		`assessmentPartId` not found
	NULL_ARGUMENT		`assessmentPartId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	canManageAssessmentPartAliases
Description	Tests if this user can manage `Id` aliases for `AssessmentParts.` 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 `AssessmentPart` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAssessmentPart
Description	Adds an `Id` to an `AssessmentPart` for the purpose of creating compatibility. The primary `Id` of the `AssessmentPart` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another assessment part, it is reassigned to the given assessment part `Id.`
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of an `AssessmentPart`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`assessmentPartId` not found
	NULL_ARGUMENT		`assessmentPartId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.