OSID - osid.recognition.ConferralAdminSession Service Interface Definition

Interface	osid.recognition.ConferralAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Conferrals.` 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 `Conferral,` a `ConferralForm` is requested using `getConferralFormForCreate()` specifying the desired peers and record `Types` or none if no record `Types` are needed. The returned `ConferralForm` 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 `ConferralForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ConferralForm` corresponds to an attempted transaction. For updates, `ConferralForms` are requested to the `Conferral` `Id` that is to be updated using `geConferralFormForUpdate().` Similarly, the `ConferralForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ConferralForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Conferrals.` To unmap a `Conferral` from the current `Academy,` the `ConferralAcademyAssignmentSession` should be used. These delete operations attempt to remove the `Conferral` 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	canCreateConferrals
Description	Tests if this user can create conferrals. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Conferral` 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 `Conferral` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateConferralWithRecordTypes
Description	Tests if this user can create a single `Conferral` using the desired record types. While `RecognitionManager.getConferralRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Conferral.` Providing an empty array tests if a `Conferral` can be created with no records.
Parameters	`osid.type.Type[]`	`conferralRecordTypes`	array of conferral record types
Return	`boolean`		`true` if `Conferral` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`conferralRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConferralFormForCreate
Description	Gets the conferral form for creating new conferrals. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`awardId`	the `Id` for the award
	`osid.id.Id`	`resourceId`	the `Id` for the recipient
	`osid.type.Type[]`	`conferralRecordTypes`	array of conferral record types
Return	`osid.recognition.ConferralForm`		the conferral form
Errors	NOT_FOUND		`awardId` or `resourceId` is not found
	NULL_ARGUMENT		`awardId, resourceId,` or `conferralRecordTypes` 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	createConferral
Description	Creates a new `Conferral.`
Parameters	`osid.recognition.ConferralForm`	`conferralForm`	the form for this `Conferral`
Return	`osid.recognition.Conferral`		the new `Conferral`
Errors	ILLEGAL_STATE		`conferralForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`conferralForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`conferralForm` did not originate from `getConferralFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateConferrals
Description	Tests if this user can update conferrals. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Conferral` 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 `Conferral` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConferralFormForUpdate
Description	Gets the conferral form for updating an existing conferral. A new conferral form should be requested for each update transaction.
Parameters	`osid.id.Id`	`conferralId`	the `Id` of the `Conferral`
Return	`osid.recognition.ConferralForm`		the conferral form
Errors	NOT_FOUND		`conferralId` is not found
	NULL_ARGUMENT		`conferralId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateConferral
Description	Updates an existing conferral.
Parameters	`osid.recognition.ConferralForm`	`conferralForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`conferralForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`conferralForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`conferralForm` did not originate from `getConferralFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteConferrals
Description	Tests if this user can delete conferrals. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Conferral` 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 `Conferral` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteConferral
Description	Deletes a `Conferral.`
Parameters	`osid.id.Id`	`conferralId`	the `Id` of the `Conferral` to remove
Errors	NOT_FOUND		`conferralId` not found
	NULL_ARGUMENT		`conferralId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageConferralAliases
Description	Tests if this user can manage `Id` aliases for `Comnents.` 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 `Conferral` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasConferral
Description	Adds an `Id` to a `Conferral` for the purpose of creating compatibility. The primary `Id` of the `Conferral` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another conferral, it is reassigned to the given conferral `Id.`
Parameters	`osid.id.Id`	`conferralId`	the `Id` of a `Conferral`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`conferralId` not found
	NULL_ARGUMENT		`conferralId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.