OSID - osid.inventory.ItemAdminSession Service Interface Definition

Interface	osid.inventory.ItemAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Items.` 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 `Item,` a `ItemForm` is requested using `getItemFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ItemForm` 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 `ItemForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ItemForm` corresponds to an attempted transaction. For updates, `ItemForms` are requested to the `Item` `Id` that is to be updated using `getItemFormForUpdate().` Similarly, the `ItemForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ItemForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Items.` To unmap a `Item` from the current `Warehouse,` the `ItemWarehouseAssignmentSession` should be used. These delete operations attempt to remove the `Item` 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	canCreateItems
Description	Tests if this user can create `Items.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Item` 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 `Item` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateItemWithRecordTypes
Description	Tests if this user can create a single `Item` using the desired record types. While `InventoryManager.getItemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Item.` Providing an empty array tests if an `Item` can be created with no records.
Parameters	`osid.type.Type[]`	`itemRecordTypes`	array of item record types
Return	`boolean`		`true` if `Item` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`itemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemFormForCreate
Description	Gets the item form for creating new items. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`itemRecordTypes`	array of item record types
Return	`osid.inventory.ItemForm`		the item form
Errors	NULL_ARGUMENT		`itemRecordTypes` 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	createItem
Description	Creates a new `Item.`
Parameters	`osid.inventory.ItemForm`	`itemForm`	the form for this `Item`
Return	`osid.inventory.Item`		the new `Item`
Errors	ILLEGAL_STATE		`itemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`itemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`itemForm` did not originate from `getItemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateItems
Description	Tests if this user can update `Items.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Item` 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 `Item` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemFormForUpdate
Description	Gets the item form for updating an existing item. A new item form should be requested for each update transaction.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item`
Return	`osid.inventory.ItemForm`		the item form
Errors	NOT_FOUND		`itemId` is not found
	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateItem
Description	Updates an existing item.
Parameters	`osid.inventory.ItemForm`	`itemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`itemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`itemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`itemForm` did not originate from `getItemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteItems
Description	Tests if this user can delete `Items.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Item` 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 `Item` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteItem
Description	Deletes an `Item.`
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to remove
Errors	NOT_FOUND		`itemId` not found
	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageItemAliases
Description	Tests if this user can manage `Id` aliases for `Items.` 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 `Item` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasItem
Description	Adds an `Id` to an `Item` for the purpose of creating compatibility. The primary `Id` of the `Item` is deinventoryined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another item, it is reassigned to the given item `Id.`
Parameters	`osid.id.Id`	`itemId`	the `Id` of an `Item`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`itemId` not found
	NULL_ARGUMENT		`itemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.