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

Interface	osid.course.program.ProgramAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Programs.` 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 `Program,` a `ProgramForm` is requested using `getProgramFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProgramForm` 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 `ProgramForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProgramForm` corresponds to an attempted transaction. For updates, `ProgramForms` are requested to the `ProgramForm` `Id` that is to be updated using `getProgramFormForUpdate().` Similarly, the `ProgramForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProgramForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Programs.` To unmap a `Program` from the current `CourseCatalog,` the `ProgramCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Program` 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	canCreatePrograms
Description	Tests if this user can create `Programs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `program` 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 `Program` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProgramWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseProgramManager.getProgramRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Program.` Providing an empty array tests if a `program` can be created with no records.
Parameters	`osid.type.Type[]`	`programRecordTypes`	array of program record types
Return	`boolean`		`true` if `Program` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramFormForCreate
Description	Gets the program form for creating new programs. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`programRecordTypes`	array of program record types
Return	`osid.course.program.ProgramForm`		the program form
Errors	NULL_ARGUMENT		`programRecordTypes` 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	createProgram
Description	Creates a new `Program.`
Parameters	`osid.course.program.ProgramForm`	`programForm`	the form for this `Program`
Return	`osid.course.program.Program`		the new `Program`
Errors	ILLEGAL_STATE		`programForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`programForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programForm` did not originate from `getProgramFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePrograms
Description	Tests if this user can update `Programs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `program` 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 `Program` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramFormForUpdate
Description	Gets the program form for updating an existing course. A new program form should be requested for each update transaction.
Parameters	`osid.id.Id`	`programId`	the `Id` of the `Program`
Return	`osid.course.program.ProgramForm`		the program form
Errors	NOT_FOUND		`programId` is not found
	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProgram
Description	Updates an existing program.
Parameters	`osid.course.program.ProgramForm`	`programForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`programForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`programForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programForm` did not originate from `getProgramFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePrograms
Description	Tests if this user can delete `Programs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Program` 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 `Program` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProgram
Description	Deletes a `Program.`
Parameters	`osid.id.Id`	`programId`	the `Id` of the `Program` to remove
Errors	NOT_FOUND		`programId` not found
	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProgramAliases
Description	Tests if this user can manage `Id` aliases for `Programs.` 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 `Program` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProgram
Description	Adds an `Id` to a `Program` 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, it is reassigned to the given program `Id.`
Parameters	`osid.id.Id`	`programId`	the `Id` of a `Program`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`programId` not found
	NULL_ARGUMENT		`programId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.