OSID - osid.course.program.ProgramOfferingAdminSession Service Interface Definition

Interface	osid.course.program.ProgramOfferingAdminSession
Implements	`osid.OsidSession`
Used By	`osid.course.program.CourseProgramManager`
Used By	`osid.course.program.CourseProgramProxyManager`
Description	This session creates, updates, and deletes `ProgramOfferings`. 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 `ProgramOffering`, a `ProgramOfferingForm` is requested using `getProgramOfferingFormForCreate()` specifying the desired canonical program, term, and record `Types` or none if no record `Types` are needed. The returned `ProgramOfferingForm` 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 `ProgramOfferingForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProgramOfferingForm` corresponds to an attempted transaction. For updates, `ProgramOfferingForms` are requested to the `ProgramOffering` `Id` that is to be updated using `getProgramOfferingFormForUpdate()`. Similarly, the `ProgramOfferingForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProgramOfferingForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ProgramEntries`. To unmap a `ProgramOffering` from the current `CourseCatalog`, the `ProgramOfferingCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `ProgramOffering` 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	canCreateProgramOfferings
Description	Tests if this user can create `ProgramOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ProgramOffering` 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 `ProgramOffering` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProgramOfferingWithRecordTypes
Description	Tests if this user can create a single `ProgramOffering` using the desired record types. While `CourseProgramManager.getProgramOfferingRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProgramOffering`. Providing an empty array tests if a `ProgramOffering` can be created with no records.
Parameters	`osid.type.Type[]`	`programOfferingRecordTypes`	array of program offering record types
Return	`boolean`		`true` if `ProgramOffering` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programOfferingRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingFormForCreate
Description	Gets the program offering form for creating new program offerings. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`programId`	the `Id` of the associated `Program`
	`osid.id.Id`	`termId`	the `Id` of the associated `Term`
	`osid.type.Type[]`	`programOfferingRecordTypes`	array of program offering record types
Return	`osid.course.program.ProgramOfferingForm`		the program offering form
Errors	NOT_FOUND		`programId` or `termId` not found
	NULL_ARGUMENT		`programId, termId` or `programOfferingRecordTypes` 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	createProgramOffering
Description	Creates a new `ProgramOffering`.
Parameters	`osid.course.program.ProgramOfferingForm`	`programOfferingForm`	the form for this `ProgramOffering`
Return	`osid.course.program.ProgramOffering`		the new `ProgramOffering`
Errors	ILLEGAL_STATE		`programOfferingForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`programOfferingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programOfferingForm` did not originate from `getProramOfferingFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProgramOfferings
Description	Tests if this user can update `ProgramOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ProgramOffering` 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 `ProgramOffering` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingFormForUpdate
Description	Gets the program offering form for updating an existing program offering. A new program offering form should be requested for each update transaction.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of the `ProgramOffering`
Return	`osid.course.program.ProgramOfferingForm`		the program offering form
Errors	NOT_FOUND		`programOfferingId` is not found
	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProgramOffering
Description	Updates an existing program offering.
Parameters	`osid.course.program.ProgramOfferingForm`	`programOfferingForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`programOfferingForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`programOfferingForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programOfferingForm` did not originate from `getProramOfferingFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProgramOfferings
Description	Tests if this user can delete `ProgramOfferings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ProgramOffering` 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 `ProgramOffering` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProgramOffering
Description	Deletes a `ProgramOffering`.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of the `ProgramOffering` to remove
Errors	NOT_FOUND		`programOfferingId` not found
	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProgramOfferingAliases
Description	Tests if this user can manage `Id` aliases for `ProgramOfferings`. 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 `ProgramOffering` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProgramOffering
Description	Adds an `Id` to a `ProgramOffering` for the purpose of creating compatibility. The primary `Id` of the `program` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another program offering, it is reassigned to the given program offering `Id`.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of a `ProgramOffering`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`programOfferingId` not found
	NULL_ARGUMENT		`programOfferingId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.