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

Interface	osid.course.chronicle.AwardEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.chronicle.batch.AwardEntryBatchAdminSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session creates, updates, and deletes `AwardEntries`. 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 an `AwardEntry`, an `AwardEntryForm` is requested using `getAwardEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AwardEntryForm` 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 `AwardEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AwardEntryForm` corresponds to an attempted transaction. For updates, `AwardEntryForms` are requested to the `AwardEntry` `Id` that is to be updated using `getAwardEntryFormForUpdate()`. Similarly, the `AwardEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AwardEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AwardEntries`. To unmap an `AwardEntryForm` from the current `CourseCatalog`, the `AwardEntryCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `AwardEntryForm` 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	canCreateAwardEntries
Description	Tests if this user can create `AwardEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AwardEntry` 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 `AwardEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAwardEntryWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseChronicleManager.getAwardEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AwardEntry`. Providing an empty array tests if an `AwardEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`awardEntryRecordTypes`	array of award entry record types
Return	`boolean`		`true` if `AwardEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryFormForCreate
Description	Gets the award entry form for creating new award entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`awardId`	an award `Id`
	`osid.id.Id`	`resourceId`	a student `Id`
	`osid.type.Type[]`	`awardEntryRecordTypes`	array of award entry record types
Return	`osid.course.chronicle.AwardEntryForm`		the award entry form
Errors	NOT_FOUND		`awardId` or `resourceId` is not found
	NULL_ARGUMENT		`awardId, resourceId`, or `awardEntryRecordTypes` 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	createAwardEntry
Description	Creates a new `AwardEntry`.
Parameters	`osid.course.chronicle.AwardEntryForm`	`awardEntryForm`	the form for this `AwardEntry`
Return	`osid.course.chronicle.AwardEntry`		the new `AwardEntry`
Errors	ILLEGAL_STATE		`awardEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`awardEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardEntryForm` did not originate from `getAwardEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAwardEntries
Description	Tests if this user can update `AwardEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AwardEntry` 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 `AwardEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryFormForUpdate
Description	Gets the award entry form for updating an existing award entry. A new award entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`awardEntryId`	the `Id` of the `AwardEntry`
Return	`osid.course.chronicle.AwardEntryForm`		the award entry form
Errors	NOT_FOUND		`awardEntryId` is not found
	NULL_ARGUMENT		`awardEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAwardEntry
Description	Updates an existing award entry.
Parameters	`osid.course.chronicle.AwardEntryForm`	`awardEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`awardEntryForm` already used in an update transaction
	INVALID_ARGUMENT		`awardEntryId` is not found
	NULL_ARGUMENT		`awardEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardEntryForm` did not originate from `getAwardEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAwardEntries
Description	Tests if this user can delete `AwardEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AwardEntry` 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 `AwardEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAwardEntry
Description	Deletes an `AwardEntry`.
Parameters	`osid.id.Id`	`awardEntryId`	the `Id` of the `AwardEntry` to remove
Errors	NOT_FOUND		`awardEntryId` not found
	NULL_ARGUMENT		`awardEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAwardEntryAliases
Description	Tests if this user can manage `Id` aliases for `AwardEntries`. 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 `AwardEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAwardEntry
Description	Adds an `Id` to an `AwardEntry` for the purpose of creating compatibility. The primary `Id` of the `AwardEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another award entry, it is reassigned to the given award entry `Id`.
Parameters	`osid.id.Id`	`awardEntryId`	the `Id` of an `AwardEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`awardEntryId` not found
	NULL_ARGUMENT		`awardEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.