OSID - osid.learning.ProficiencyAdminSession Service Interface Definition

Interface	osid.learning.ProficiencyAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.learning.batch.ProficiencyBatchAdminSession`
Used By	`osid.learning.LearningManager`
Used By	`osid.learning.LearningProxyManager`
Description	This session creates, updates, and deletes `Proficiencies`. 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 `Proficiency`, a `ProficiencyForm` is requested using `getProficiencyFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `ProficiencyForm` 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 `ProficiencyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProficiencyForm` corresponds to an attempted transaction. For updates, `ProficiencyForms` are requested to the `Proficiency` `Id` that is to be updated using `getProficiencyFormForUpdate()`. Similarly, the `ProficiencyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProficiencyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Proficiencies`. To unmap a `Proficiency` from the current `ObjectiveBank`, the `ProficiencyObjectiveBankAssignmentSession` should be used. These delete operations attempt to remove the `Proficiency` itself thus removing it from all known `ObjectiveBank` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the obective bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProficiencies
Description	Tests if this user can create `Proficiencies`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Proficiency` 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 `Proficiency` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProficiencyWithRecordTypes
Description	Tests if this user can create a single `Proficiency` using the desired record types. While `LearningManager.getProficiencyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Proficiency`. Providing an empty array tests if a `Proficiency` can be created with no records.
Parameters	`osid.type.Type[]`	`proficiencyRecordTypes`	array of proficiency record types
Return	`boolean`		`true` if `Proficiency` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`proficiencyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyFormForCreate
Description	Gets the proficiency form for creating new proficiencies. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective`
	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
	`osid.type.Type[]`	`proficiencyRecordTypes`	array of proficiency record types
Return	`osid.learning.ProficiencyForm`		the proficiency form
Errors	NOT_FOUND		`objectiveId` or `resourceId` is not found
	NULL_ARGUMENT		`objectiveId, resourceId`, or `proficienyRecordTypes` 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	createProficiency
Description	Creates a new `Proficiency`. A new form should be requested for each create transaction.
Parameters	`osid.learning.ProficiencyForm`	`proficiencyForm`	the form for this `Proficiency`
Return	`osid.learning.Proficiency`		the new `Proficiency`
Errors	ILLEGAL_STATE		`proficiencyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`proficiencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`proficiencyForm` did not originate from `getProficiencyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProficiencies
Description	Tests if this user can update `Proficiencies`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Proficiency` 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 `Proficiency` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyFormForUpdate
Description	Gets the proficiency form for updating an existing proficiency.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of the `Proficiency`
Return	`osid.learning.ProficiencyForm`		the proficiency form
Errors	NOT_FOUND		`proficiencyId` is not found
	NULL_ARGUMENT		`proficiencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProficiency
Description	Updates an existing proficiency.
Parameters	`osid.learning.ProficiencyForm`	`proficiencyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`proficiencyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`proficiencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`proficiencyForm` did not originate from `getProficiencyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProficiencies
Description	Tests if this user can delete `Proficiencies`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Proficiency` 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 `Proficiency` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProficiency
Description	Deletes a `Proficiency`.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of the `Proficiency` to remove
Errors	NOT_FOUND		`proficiencyId` not found
	NULL_ARGUMENT		`proficiencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	deleteProficiencies
Description	Deletes all proficiencies in this `ObjectiveBank`.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProficiencyAliases
Description	Tests if this user can manage `Id` aliases for proficiency entries. 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 `Proficiency` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProficiency
Description	Adds an `Id` to a `Proficiency` for the purpose of creating compatibility. The primary `Id` of the `Proficiency` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another proficiency, it is reassigned to the given proficiency `Id`.
Parameters	`osid.id.Id`	`proficiencyId`	the `Id` of a `Proficiency`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`proficiencyId` not found
	NULL_ARGUMENT		`proficiencyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.