OSID - osid.course.chronicle.AssessmentEntryAdminSession Service Interface Definition

Interface	osid.course.chronicle.AssessmentEntryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `AssessmentEntries.` 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 `AssessmentEntry,` an `AssessmentEntryForm` is requested using `getAssessmentEntryFormForCreate()` specifying the desired award, student, and record `Types` or none if no record `Types` are needed. The returned `AssessmentEntryForm` 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 `AssessmentEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AssessmentEntryForm` corresponds to an attempted transaction. For updates, `AssessmentEntryForms` are requested to the `AssessmentEntry` `Id` that is to be updated using `getAssessmentEntryFormForUpdate().` Similarly, the `AssessmentEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AssessmentEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AssessmentEntries.` To unmap an `AssessmentEntry` from the current `CourseCatalog,` the `AssessmentEntryCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `AssessmentEntryForm` itself thus removing it from all known `CourseCatalog` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentEntries
Description	Tests if this user can create `AssessmentEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AssessmentEntry` 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 `AssessmentEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssessmentEntryWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseChronicleManager.getAssessmentEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AssessmentEntry.` Providing an empty array tests if an `AssessmentEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`assessmentEntryRecordTypes`	array of assessment entry record types
Return	`boolean`		`true` if `AssessmentEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntryFormForCreate
Description	Gets the assessment entry form for creating new assessment entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
	`osid.id.Id`	`resourceId`	a student `Id`
	`osid.type.Type[]`	`assessmentEntryRecordTypes`	array of assessment entry record types
Return	`osid.course.chronicle.AssessmentEntryForm`		the assessment entry form
Errors	NOT_FOUND		`assessmentId` or `resourceId` is not found
	NULL_ARGUMENT		`assessmentId, resourceId,` or `assessmentEntryRecordTypes` 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	createAssessmentEntry
Description	Creates a new `AssessmentEntry.`
Parameters	`osid.course.chronicle.AssessmentEntryForm`	`assessmentEntryForm`	the form for this `AssessmentEntry`
Return	`osid.course.chronicle.AssessmentEntry`		the new `AssessmentEntry`
Errors	ILLEGAL_STATE		`assessmentEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`assessmentEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assessmentEntryForm` did not originate from `getAssessmentEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAssessmentEntries
Description	Tests if this user can update `AssessmentEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AssessmentEntry` 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 `AssessmentEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntryFormForUpdate
Description	Gets the assessment entry form for updating an existing assessment entry. A new assessment entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`assessmentEntryId`	the `Id` of the `AssessmentEntry`
Return	`osid.course.chronicle.AssessmentEntryForm`		the assessment entry form
Errors	NOT_FOUND		`assessmentEntryId` is not found
	NULL_ARGUMENT		`assessmentEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAssessmentEntry
Description	Updates an existing assessment entry.
Parameters	`osid.course.chronicle.AssessmentEntryForm`	`assessmentEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`assessmentEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`assessmentEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assessmentEntryForm` did not originate from `getAssessmentEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssessmentEntries
Description	Tests if this user can delete `AssessmentEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AssessmentEntry` 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 `AssessmentEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssessmentEntry
Description	Tests if this user can delete a specified `AssessmentEntry.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `AssessmentEntry` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this assessment entry.
Parameters	`osid.id.Id`	`assessmentEntryId`	the `Id` of the `AssessmentEntry`
Return	`boolean`		`false` if deletion of this `AssessmentEntry` is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`assessmentEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `assessmentEntryId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteAssessmentEntry
Description	Deletes an `AssessmentEntry.`
Parameters	`osid.id.Id`	`assessmentEntryId`	the `Id` of the `AssessmentEntry` to remove
Errors	NOT_FOUND		`assessmentEntryId` not found
	NULL_ARGUMENT		`assessmentEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAssessmentEntryAliases
Description	Tests if this user can manage `Id` aliases for `AssessmentEntries.` 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 `AssessmentEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAssessmentEntry
Description	Adds an `Id` to an `AssessmentEntry` for the purpose of creating compatibility. The primary `Id` of the `AssessmentEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another assessment entry, it is reassigned to the given assessment entry `Id.`
Parameters	`osid.id.Id`	`assessmentEntryId`	the `Id` of an `AssessmentEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`assessmentEntryId` not found
	NULL_ARGUMENT		`assessmentEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.