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

Interface	osid.course.chronicle.CourseEntryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `CourseEntries.` 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 `CourseEntry,` a `CourseEntryForm` is requested using `getCourseEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CourseEntryForm` 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 `CourseEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CourseEntryForm` corresponds to an attempted transaction. For updates, `CourseEntryForms` are requested to the `CourseEntry` `Id` that is to be updated using `getCourseEntryFormForUpdate().` Similarly, the `CourseEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CourseEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CourseEntries.` To unmap a `CourseEntry` from the current `CourseCatalog,` the `CourseEntryCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `CourseEntry` 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	canCreateCourseEntries
Description	Tests if this user can create `CourseEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CourseEntry` 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 `CourseEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCourseEntryWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseChronicleManager.getCourseEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CourseEntry.` Providing an empty array tests if a `CourseEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`courseEntryRecordTypes`	array of course entry record types
Return	`boolean`		`true` if `CourseEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryFormForCreate
Description	Gets the course entry form for creating new course entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
	`osid.id.Id`	`resourceId`	a program `Id`
	`osid.type.Type[]`	`courseEntryRecordTypes`	array of course entry record types
Return	`osid.course.chronicle.CourseEntryForm`		the course entry form
Errors	NOT_FOUND		`courseId` or `resourceId` is not found
	NULL_ARGUMENT		`courseId, resourceId` , or `courseEntryRecordTypes` 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	createCourseEntry
Description	Creates a new `CourseEntry.`
Parameters	`osid.course.chronicle.CourseEntryForm`	`courseEntryForm`	the form for this `CourseEntry`
Return	`osid.course.chronicle.CourseEntry`		the new `CourseEntry`
Errors	ILLEGAL_STATE		`courseEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`courseEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseEntryForm` did not originate from `getCourseEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCourseEntries
Description	Tests if this user can update `CourseEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CourseEntry` 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 `CourseEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryFormForUpdate
Description	Gets the course entry form for updating an existing course entry. A new course entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`courseEntryId`	the `Id` of the `CourseEntry`
Return	`osid.course.chronicle.CourseEntryForm`		the course entry form
Errors	NOT_FOUND		`courseEntryId` is not found
	NULL_ARGUMENT		`courseEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCourseEntry
Description	Updates an existing course entry.
Parameters	`osid.course.chronicle.CourseEntryForm`	`courseEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`courseEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`courseEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`courseEntryForm did not originate from getCourseEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCourseEntries
Description	Tests if this user can delete `CourseEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CourseEntry` 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 `CourseEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCourseEntry
Description	Deletes a `CourseEntry.`
Parameters	`osid.id.Id`	`courseEntryId`	the `Id` of the `CourseEntry` to remove
Errors	NOT_FOUND		`courseEntryId` not found
	NULL_ARGUMENT		`courseEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCourseEntryAliases
Description	Tests if this user can manage `Id` aliases for `CourseEntries.` 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 `CourseEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCourseEntry
Description	Adds an `Id` to a `CourseEntry` for the purpose of creating compatibility. The primary `Id` of the `CourseEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another course entry, it is reassigned to the given course entry `Id.`
Parameters	`osid.id.Id`	`courseEntryId`	the `Id` of a `CourseEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`courseEntryId` not found
	NULL_ARGUMENT		`courseEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.