OSID - osid.inventory.WarehouseAdminSession Service Interface Definition

Interface	osid.inventory.WarehouseAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Warehouses.` 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 `Warehouse,` a `WarehouseForm` is requested using `getWarehouseFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `WarehouseForm` 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 `WarehouseForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `WarehouseForm` corresponds to an attempted transaction. For updates, `WarehouseForms` are requested to the `Warehouse` `Id` that is to be updated using `getWarehouseFormForUpdate().` Similarly, the `WarehouseForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `WarehouseForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Warehouses.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateWarehouses
Description	Tests if this user can create `Warehouses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Warehouse.` 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 `Warehouse` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateWarehouseWithRecordTypes
Description	Tests if this user can create a single `Warehouse` using the desired record types. While `InventoryManager.getWarehouseRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Warehouse.` Providing an empty array tests if a `Warehouse` can be created with no records.
Parameters	`osid.type.Type[]`	`warehouseRecordTypes`	array of warehouse record types
Return	`boolean`		`true` if `Warehouse` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`warehouseRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseFormForCreate
Description	Gets the warehouse form for creating new warehouses. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`warehouseRecordTypes`	array of warehouse record types
Return	`osid.inventory.WarehouseForm`		the warehouse form
Errors	NULL_ARGUMENT		`warehouseRecordTypes` 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	createWarehouse
Description	Creates a new `Warehouse.`
Parameters	`osid.inventory.WarehouseForm`	`warehouseForm`	the form for this `Warehouse`
Return	`osid.inventory.Warehouse`		the new `Warehouse`
Errors	ILLEGAL_STATE		`warehouseForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`warehouseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`warehouseForm` did not originate from `getWarehouseFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateWarehouses
Description	Tests if this user can update `Warehouses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Warehouse` 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 `Warehouse` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseFormForUpdate
Description	Gets the warehouse form for updating an existing warehouse. A new warehouse form should be requested for each update transaction.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.WarehouseForm`		the warehouse form
Errors	NOT_FOUND		`warehouseId` is not found
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateWarehouse
Description	Updates an existing warehouse.
Parameters	`osid.inventory.WarehouseForm`	`warehouseForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`warehouseForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`warehouseForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`warehouseForm` did not originate from `getWarehouseFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteWarehouses
Description	Tests if this user can delete `Warehouses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Warehouse` 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 `Warehouse` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteWarehouse
Description	Deletes a `Warehouse.`
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse` to remove
Errors	NOT_FOUND		`warehouseId` not found
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageWarehouseAliases
Description	Tests if this user can manage `Id` aliases for `Warehouses.` 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 `Warehouse` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasWarehouse
Description	Adds an `Id` to a `Warehouse` for the purpose of creating compatibility. The primary `Id` of the `Warehouse` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another warehouse, it is reassigned to the given warehouse `Id.`
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of a `Warehouse`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`aliasId` is in use as a primary `Id`
	NULL_ARGUMENT		`warehouseId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.