OSID - osid.personnel.PositionAdminSession Service Interface Definition

Interface	osid.personnel.PositionAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.personnel.batch.PositionBatchAdminSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session creates, updates, and deletes `Positions`. 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 `Position`, a `PositionForm` is requested using `getPositionFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PositionForm` 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 `PositionForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PositionForm` corresponds to an attempted transaction. For updates, `PositionForms` are requested to the `Position` `Id` that is to be updated using `getPositionFormForUpdate()`. Similarly, the `PositionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PositionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Positions`. To unmap a `Position` from the current `Realm`, the `PositionRealmAssignmentSession` should be used. These delete operations attempt to remove the `Position` itself thus removing it from all known `Realm` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePositions
Description	Tests if this user can create positions. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Position` 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 `Position` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePositionWithRecordTypes
Description	Tests if this user can create a single `Position` using the desired record types. While `PersonnelManager.getPositionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Position`. Providing an empty array tests if a `Position` can be created with no records.
Parameters	`osid.type.Type[]`	`positionRecordTypes`	array of position record types
Return	`boolean`		`true` if `Position` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`positionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPositionFormForCreate
Description	Gets the position form for creating new positions. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`organizationId`	the organization `Id` to which this position belongs
Parameters	`osid.type.Type[]`	`positionRecordTypes`	array of position record types to be included in the create operation or an empty list if none
Return	`osid.personnel.PositionForm`		the position form
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`organizationId` or `positionRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createPosition
Description	Creates a new `Position`.
Parameters	`osid.personnel.PositionForm`	`positionForm`	the form for this `Position`
Return	`osid.personnel.Position`		the new `Position`
Errors	ILLEGAL_STATE		`positionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`positionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`positionForm` did not originate from `getPositionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePositions
Description	Tests if this user can update positions. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Position` 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 `Position` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPositionFormForUpdate
Description	Gets the position form for updating an existing position. A new position form should be requested for each update transaction.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the `Position`
Return	`osid.personnel.PositionForm`		the position form
Errors	NOT_FOUND		`positionId` is not found
	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePosition
Description	Updates an existing position.
Parameters	`osid.personnel.PositionForm`	`positionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`positionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`positionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`positionForm` did not originate from `getPositionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePositions
Description	Tests if this user can delete positions. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Position` 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 `Position` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePosition
Description	Deletes a `Position`.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the `Position` to remove
Errors	NOT_FOUND		`positionId` not found
	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePositionAliases
Description	Tests if this user can manage `Id` aliases for `Positions`. 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 `Position` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPosition
Description	Adds an `Id` to a `Position` for the purpose of creating compatibility. The primary `Id` of the `Position` is determined by the provider. The new `Id` is an alias to the primary `Id`. If the alias is a pointer to another position, it is reassigned to the given position `Id`.
Parameters	`osid.id.Id`	`positionId`	the `Id` of a `Position`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`positionId` not found
	NULL_ARGUMENT		`positionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.