OSID - osid.course.CourseOfferingAdminSession Service Interface Definition

Interface	osid.course.CourseOfferingAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.batch.CourseOfferingBatchAdminSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session creates, updates, and deletes `CourseOfferings`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `CourseOffering`, a `CourseOfferingForm` is requested using `getCourseOfferingFormForCreate()` specifying the desired course, term, and record `Types` or none if no record `Types` are needed. The returned `CourseOfferingForm` 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 `CourseOfferingForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CourseOfferingForm` corresponds to an attempted transaction. For updates, `CourseOfferingForms` are requested to the `CourseOffering` `Id` that is to be updated using `getCourseOfferingFormForUpdate()`. Similarly, the `CourseOfferingForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CourseOfferingForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CourseOfferings`. To unmap a `CourseOffering` from the current `CourseCatalog`, the `CourseOfferingCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `CourseOffering` 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	canCreateCourseOfferings
Description	Tests if this user can create `CourseOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CourseOffering` 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 `CourseOffering` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCourseOfferingWithRecordTypes
Description	Tests if this user can create a single `CourseOffering` using the desired record types. While `CourseManager.getCourseOfferingRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CourseOffering`. Providing an empty array tests if a `CourseOffering` can be created with no records.
Parameters	`osid.type.Type[]`	`courseOfferingRecordTypes`	array of course offering record types
Return	`boolean`		`true` if `CourseOffering` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseOfferingRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingFormForCreate
Description	Gets the course form for creating new course offerings. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseId`	the Id of the associated Course
	`osid.id.Id`	`termId`	the Id of the associated Term
	`osid.type.Type[]`	`courseOfferingRecordTypes`	array of course offering record types
Return	`osid.course.CourseOfferingForm`		the course offering form
Errors	NOT_FOUND		`courseId` or `termId` not found
	NULL_ARGUMENT		`courseId, termId` or `courseOfferingRecordTypes` 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	createCourseOffering
Description	Creates a new `CourseOffering`.
Parameters	`osid.course.CourseOfferingForm`	`courseOfferingForm`	the form for this `CourseOffering`
Return	`osid.course.CourseOffering`		the new `CourseOffering`
Errors	ILLEGAL_STATE		`courseOfferingForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`courseOfferingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityForm did not originate from getCourseOfferingFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCourseOfferings
Description	Tests if this user can update `CourseOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CourseOffering` 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 `CourseOffering` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingFormForUpdate
Description	Gets the course offering form for updating an existing course offering. A new course offering form should be requested for each update transaction.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering`
Return	`osid.course.CourseOfferingForm`		the course offering form
Errors	NOT_FOUND		`courseOfferingId` is not found
	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCourseOffering
Description	Updates an existing course offering.
Parameters	`osid.course.CourseOfferingForm`	`courseOfferingForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`courseOfferingForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`courseOfferingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityForm did not originate from getCourseOfferingFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCourseOfferings
Description	Tests if this user can delete `CourseOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CourseOffering` 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 `CourseOffering` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCourseOffering
Description	Deletes a `CourseOffering`.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to remove
Errors	NOT_FOUND		`courseOfferingId` not found
	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCourseOfferingAliases
Description	Tests if this user can manage `Id` aliases for `CourseOfferings`. 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 `CourseOffering` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCourseOffering
Description	Adds an `Id` to a `CourseOffering` for the purpose of creating compatibility. The primary `Id` of the `Course` 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 offering, it is reassigned to the given course offering `Id`.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`courseOfferingId` not found
	NULL_ARGUMENT		`courseOfferingId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.