OSID - osid.recognition.AwardAdminSession Service Interface Definition

Interface	osid.recognition.AwardAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Awards.` 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 `Award,` an `AwardForm` is requested using `getAwardFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AwardForm` 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 `AwardForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AwardForm` corresponds to an attempted transaction. For updates, `AwardForms` are requested to the `Award` `Id` that is to be updated using `getAwardFormForUpdate().` Similarly, the `AwardForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AwardForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Awards.` To unmap an `Award` from the current `Academy,` the `AwardAcademyAssignmentSession` should be used. These delete operations attempt to remove the `Award` itself thus removing it from all known `Academy` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getAcademyId
Description	Gets the `Academy` `Id` associated with this session.
Return	`osid.id.Id`		the `Academy Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAcademy
Description	Gets the `Academy` associated with this session.
Return	`osid.recognition.Academy`		the academy
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAwards
Description	Tests if this user can create `Awards.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Award` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Award` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAwardWithRecordTypes
Description	Tests if this user can create a single `Award` using the desired record types. While `RecognitionManager.getAwardRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Award.` Providing an empty array tests if an `Award` can be created with no records.
Parameters	`osid.type.Type[]`	`awardRecordTypes`	array of award record types
Return	`boolean`		`true` if `Award` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardFormForCreate
Description	Gets the award form for creating new awards. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`awardRecordTypes`	array of award record types
Return	`osid.recognition.AwardForm`		the award form
Errors	NULL_ARGUMENT		`awardRecordTypes` 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	createAward
Description	Creates a new `Award.`
Parameters	`osid.recognition.AwardForm`	`awardForm`	the form for this `Award`
Return	`osid.recognition.Award`		the new `Award`
Errors	ILLEGAL_STATE		`awardForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`awardForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardForm` did not originate from `getAwardFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAwards
Description	Tests if this user can update `Awards.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Award` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Award` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardFormForUpdate
Description	Gets the award form for updating an existing award. A new award form should be requested for each update transaction.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the `Award`
Return	`osid.recognition.AwardForm`		the award form
Errors	NOT_FOUND		`awardId` is not found
	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAward
Description	Updates an existing award.
Parameters	`osid.recognition.AwardForm`	`awardForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`awardForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`awardForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardForm` did not originate from `getAwardFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAwards
Description	Tests if this user can delete `Awards` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Award` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Award` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAward
Description	Deletes an `Award.`
Parameters	`osid.id.Id`	`awardId`	the `Id` of the `Award` to remove
Errors	NOT_FOUND		`awardId` not found
	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAwardAliases
Description	Tests if this user can manage `Id` aliases for `Awards.` 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 `Award` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAward
Description	Adds an `Id` to an `Award` for the purpose of creating compatibility. The primary `Id` of the `Award` 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, it is reassigned to the given award `Id.`
Parameters	`osid.id.Id`	`awardId`	the `Id` of an `Award`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`awardId` not found
	NULL_ARGUMENT		`awardId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.