OSID - osid.inventory.InventoryAdminSession Service Interface Definition

Interface	osid.inventory.InventoryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Inventories.` 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 an `Inventory,` an `InventoryForm` is requested using `getInventoryFormForCreate()` specifying the desired stock and record `Types` or none if no record `Types` are needed. The returned `InventoryForm` 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 `InventoryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `InventoryForm` corresponds to an attempted transaction. For updates, `InventoryForms` are requested to the `Inventory` `Id` that is to be updated using `getInventoryFormForUpdate().` Similarly, the `InventoryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `InventoryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Inventories.` To unmap an `Inventory` from the current `Warehouse,` the `InventoryWarehouseAssignmentSession` should be used. These delete operations attempt to remove the `Inventory` itself thus removing it from all known `Warehouse` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInventories
Description	Tests if this user can create `Inventories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Inventory` 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 `Inventory` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateInventoryWithRecordTypes
Description	Tests if this user can create a single `Inventory` using the desired record types. While `InventoryManager.getInventoryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Inventory.` Providing an empty array tests if an `Inventory` can be created with no records.
Parameters	`osid.type.Type[]`	`inventoryRecordTypes`	array of inventory record types
Return	`boolean`		`true` if `Inventory` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inventoryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryFormForCreate
Description	Gets the inventory form for creating new inventories. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Parameters	`osid.type.Type[]`	`inventoryRecordTypes`	array of inventory record types
Return	`osid.inventory.InventoryForm`		the inventory form
Errors	NOT_FOUND		`stockId` is not found
	NULL_ARGUMENT		`stockId` or `inventoryRecordTypes` 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	createInventory
Description	Creates a new `Inventory.`
Parameters	`osid.inventory.InventoryForm`	`inventoryForm`	the form for this `Inventory`
Return	`osid.inventory.Inventory`		the new `Inventory`
Errors	ILLEGAL_STATE		`inventoryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`inventoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inventoryForm` did not originate from `getInventoryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateInventories
Description	Tests if this user can update `Inventories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Inventory` 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 `Inventory` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryFormForUpdate
Description	Gets the inventory form for updating an existing inventory. A new inventory form should be requested for each update transaction.
Parameters	`osid.id.Id`	`inventoryId`	the `Id` of the `Inventory`
Return	`osid.inventory.InventoryForm`		the inventory form
Errors	NOT_FOUND		`inventoryId` is not found
	NULL_ARGUMENT		`inventoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInventory
Description	Updates an existing inventory.
Parameters	`osid.inventory.InventoryForm`	`inventoryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`inventoryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`inventoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inventoryForm` did not originate from `getInventoryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInventories
Description	Tests if this user can delete `Inventories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Inventory` 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 `Inventory` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteInventory
Description	Tests if this user can delete a specified `Inventory.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `Inventory` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this inventory.
Parameters	`osid.id.Id`	`inventoryId`	the `Id` of the `Inventory`
Return	`boolean`		`false` if deletion of this `Inventory` is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`inventoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `inventoryId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteInventory
Description	Deletes an `Inventory.`
Parameters	`osid.id.Id`	`inventoryId`	the `Id` of the `Inventory` to remove
Errors	NOT_FOUND		`inventoryId` not found
	NULL_ARGUMENT		`inventoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageInventoryAliases
Description	Tests if this user can manage `Id` aliases for `Inventories.` 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 `Inventory` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasInventory
Description	Adds an `Id` to an `Inventory` for the purpose of creating compatibility. The primary `Id` of the `Inventory` is deinventoryined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another inventory, it is reassigned to the given inventory `Id.`
Parameters	`osid.id.Id`	`inventoryId`	the `Id` of an `Inventory`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`inventoryId` not found
	NULL_ARGUMENT		`inventoryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.