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

Interface	osid.course.chronicle.ProgramEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.chronicle.batch.ProgramEntryBatchAdminSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session creates, updates, and deletes `ProgramEntries`. 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 `ProgramEntry`, a `ProgramEntryForm` is requested using `getProgramEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProgramEntryForm` 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 `ProgramEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProgramEntryForm` corresponds to an attempted transaction. For updates, `ProgramEntryForms` are requested to the `ProgramEntry` `Id` that is to be updated using `getProgramEntryFormForUpdate()`. Similarly, the `ProgramEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProgramEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ProgramEntries`. To unmap a `ProgramEntry` from the current `CourseCatalog`, the `ProgramEntryCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `ProgramEntry` 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	canCreateProgramEntries
Description	Tests if this user can create `ProgramEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ProgramEntry` 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 `ProgramEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProgramEntryWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseChronicleManager.getProgramEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProgramEntry`. Providing an empty array tests if a `ProgramEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`programEntryRecordTypes`	array of program entry record types
Return	`boolean`		`true` if `ProgramEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryFormForCreate
Description	Gets the program entry form for creating new program entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`programId`	the `Id` of a `Program`
	`osid.id.Id`	`resourceId`	the `Id` of a student
	`osid.type.Type[]`	`programEntryRecordTypes`	array of program entry record types
Return	`osid.course.chronicle.ProgramEntryForm`		the program entry form
Errors	NOT_FOUND		`programId` or `resourceId` is not found
	NULL_ARGUMENT		`programId, resourceId`, or `programEntryRecordTypes` 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	createProgramEntry
Description	Creates a new `ProgramEntry`.
Parameters	`osid.course.chronicle.ProgramEntryForm`	`programEntryForm`	the form for this `ProgramEntry`
Return	`osid.course.chronicle.ProgramEntry`		the new `ProgramEntry`
Errors	ILLEGAL_STATE		`programEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`programEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programEntryForm` did not originate from `getProgramEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProgramEntries
Description	Tests if this user can update `ProgramEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ProgramEntry` 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 `ProgramEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryFormForUpdate
Description	Gets the program entry form for updating an existing program entry. A new program entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
Return	`osid.course.chronicle.ProgramEntryForm`		the program entry form
Errors	NOT_FOUND		`programEntryId` is not found
	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProgramEntry
Description	Updates an existing program entry.
Parameters	`osid.course.chronicle.ProgramEntryForm`	`programEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`programEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`programEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`programEntryForm` did not originate from `getProgramEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProgramEntries
Description	Tests if this user can delete `ProgramEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ProgramEntry` 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 `ProgramEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProgramEntry
Description	Tests if this user can delete a specified `ProgramEntry`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `ProgramEntry` 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 program entry.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry`
Return	`boolean`		`false` if deletion of this `ProgramEntry` is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`programEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `programEntryId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteProgramEntry
Description	Deletes a `ProgramEntry`.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry` to remove
Errors	NOT_FOUND		`programEntryId` not found
	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProgramEntryAliases
Description	Tests if this user can manage `Id` aliases for `ProgramEntries`. 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 `ProgramEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProgramEntry
Description	Adds an `Id` to a `ProgramEntry` for the purpose of creating compatibility. The primary `Id` of the `ProgramEntry` 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 entry, it is reassigned to the given program entry `Id`.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of a `ProgramEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`programEntryId` not found
	NULL_ARGUMENT		`programEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.