OSID - osid.resourcing.CompetencyAdminSession Service Interface Definition

Interface	osid.resourcing.CompetencyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Competencies.` 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 `Competency,` a `CompetencyForm` is requested using `getCompetencyFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `CompetencyForm` 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 `CompetencyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CompetencyForm` corresponds to an attempted transaction. For updates, `CompetencyForms` are requested to the `Competency` `Id` that is to be updated using `getCompetencyFormForUpdate().` Similarly, the `CompetencyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CompetencyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Competencies.` To unmap a `Competency` from the current `Foundry,` the `CompetencyFoundryAssignmentSession` should be used. These delete operations attempt to remove the `Competency` itself thus removing it from all known `Foundry` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getJobId
Description	Gets the `Job` `Id` associated with this session.
Return	`osid.id.Id`		the `Job Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJob
Description	Gets the `Job` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompetency
Description	Tests if this user can create competencies. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Competency` 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 `Competency` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompetencyWithRecordTypes
Description	Tests if this user can create a single `Competency` using the desired record types. While `ResourcingManager.getCompetencyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Competency.` Providing an empty array tests if a `Competency` can be created with no records.
Parameters	`osid.type.Type[]`	`competencyRecordTypes`	array of competency record types
Return	`boolean`		`true` if `Competency` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`competencyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyFormForCreate
Description	Gets the competency form for creating new competencies. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`competencyRecordTypes`	array of competency record types
Return	`osid.resourcing.CompetencyForm`		the competency form
Errors	NULL_ARGUMENT		`competencyRecordTypes` 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	createCompetency
Description	Creates a new `Competency.`
Parameters	`osid.resourcing.CompetencyForm`	`competencyForm`	the form for this `Competency`
Return	`osid.resourcing.Competency`		the new `Competency`
Errors	ILLEGAL_STATE		`competencyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`competencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`competencyForm` did not originate from `getCompetencyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCompetencies
Description	Tests if this user can update competencies. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Competency` 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 `Competency` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyFormForUpdate
Description	Gets the competency form for updating an existing competency. A new competency form should be requested for each update transaction.
Parameters	`osid.id.Id`	`competencyId`	the `Id` of the `Competency`
Return	`osid.resourcing.CompetencyForm`		the competency form
Errors	NOT_FOUND		`competencyId` is not found
	NULL_ARGUMENT		`competencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCompetency
Description	Updates an existing competency.
Parameters	`osid.resourcing.CompetencyForm`	`competencyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`competencyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`competencyId` or `competencyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`competencyForm` did not originate from `getCompetencyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCompetencies
Description	Tests if this user can delete competencies. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Competency` 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 `Competency` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCompetency
Description	Deletes a `Competency.`
Parameters	`osid.id.Id`	`competencyId`	the `Id` of the `Competency` to remove
Errors	NOT_FOUND		`competencyId` not found
	NULL_ARGUMENT		`competencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCompetencyAliases
Description	Tests if this user can manage `Id` aliases for competencies. 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 `Competency` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCompetency
Description	Adds an `Id` to a `Competency` for the purpose of creating compatibility. The primary `Id` of the `Competency` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another competency, it is reassigned to the given competency `Id.`
Parameters	`osid.id.Id`	`competencyId`	the `Id` of a `Competency`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`competencyId` not found
	NULL_ARGUMENT		`competencyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.