OSID - osid.recognition.ConvocationAdminSession Service Interface Definition

Interface	osid.recognition.ConvocationAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Convocations.` 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 `Convocation,` a `ConvocationForm` is requested using `getConvocationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ConvocationForm` 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 `ConvocationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ConvocationForm` corresponds to an attempted transaction. For updates, `ConvocationForms` are requested to the `Convocation` `Id` that is to be updated using `getConvocationFormForUpdate().` Similarly, the `ConvocationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ConvocationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Convocations.` To unmap a `Convocation` from the current `Academy,` the `ConvocationAcademyAssignmentSession` should be used. These delete operations attempt to remove the `Convocation` 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	canCreateConvocations
Description	Tests if this user can create convocations. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Convocation` 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 `Convocation` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateConvocationWithRecordTypes
Description	Tests if this user can create a single `Convocation` using the desired record types. While `RecognitionManager.getConvocationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Convocation.` Providing an empty array tests if a `Convocation` can be created with no records.
Parameters	`osid.type.Type[]`	`convocationRecordTypes`	array of convocation record types
Return	`boolean`		`true` if `Convocation` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`convocationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationFormForCreate
Description	Gets the convocation form for creating new convocations. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`convocationRecordTypes`	array of convocation record types
Return	`osid.recognition.ConvocationForm`		the convocation form
Errors	NULL_ARGUMENT		`convocationRecordTypes` 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	createConvocation
Description	Creates a new `Convocation.`
Parameters	`osid.recognition.ConvocationForm`	`convocationForm`	the form for this `Convocation`
Return	`osid.recognition.Convocation`		the new `Convocation`
Errors	ILLEGAL_STATE		`convocationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`convocationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`convocationForm` did not originate from `getConvocationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateConvocations
Description	Tests if this user can update convocations. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Convocation` 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 `Convocation` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationFormForUpdate
Description	Gets the convocation form for updating an existing convocation. A new convocation form should be requested for each update transaction.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the `Convocation`
Return	`osid.recognition.ConvocationForm`		the convocation form
Errors	NOT_FOUND		`convocationId` is not found
	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateConvocation
Description	Updates an existing convocation.
Parameters	`osid.recognition.ConvocationForm`	`convocationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		the form contains an invalid value
	INVALID_ARGUMENT		`convocationForm` already used in an update transaction
	NULL_ARGUMENT		`convocationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`convocationForm` did not originate from `getConvocationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteConvocations
Description	Tests if this user can delete convocations. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Convocation` 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 `Convocation` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteConvocation
Description	Deletes a `Convocation.`
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the `Convocation` to remove
Errors	NOT_FOUND		`convocationId` not found
	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageConvocationAliases
Description	Tests if this user can manage `Id` aliases for `Convocations.` 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 `Convocation` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasConvocation
Description	Adds an `Id` to a `Convocation` for the purpose of creating compatibility. The primary `Id` of the `Convocation` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another convocation, it is reassigned to the given convocation `Id.`
Parameters	`osid.id.Id`	`convocationId`	the `Id` of a `Convocation`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`convocationId` not found
	NULL_ARGUMENT		`convocationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageConvocations
Description	Tests if this user can manage convocations. 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 `Convocation` management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addAward
Description	Adds an award to a convocation.
Parameters	`osid.id.Id`	`awardId`	the `Id` of an `Award`
Parameters	`osid.id.Id`	`convocationId`	the `Id` of a `Convocation`
Errors	ALREADY_EXISTS		`awardId` is already part of `convocationId`
	NOT_FOUND		`awardId` or `convocationId` not found
	NULL_ARGUMENT		`awardid` or `convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeAward
Description	removes an award from a convocation.
Parameters	`osid.id.Id`	`awardId`	the `Id` of an `Award`
Parameters	`osid.id.Id`	`convocationId`	the `Id` of a `Convocation`
Errors	NOT_FOUND		`awardId` or `convocationId` not found or `awardid` not part of `convocationId`
	NULL_ARGUMENT		`awardid` or `convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.