org.osid.inventory

Interface InventoryWarehouseSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface InventoryWarehouseSession
extends OsidSession

This session provides methods to retrieve Inventory to Warehouse mappings. An Inventory may appear in multiple Warehouse objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupInventoryWarehouseMappings() Tests if this user can perform lookups of inventory/warehouse mappings.
InventoryList	getActivitieByWarehouse(Id warehouseId) Gets the list of Inventory associated with a Warehouse.
InventoryList	getActivitieByWarehouses(IdList warehouseIds) Gets the list of Inventories corresponding to a list of Warehouse objects.
IdList	getInventoryIdsByWarehouse(Id warehouseId) Gets the list of Inventory Ids associated with a Warehouse.
IdList	getInventoryIdsByWarehouses(IdList warehouseIds) Gets the list of Inventory Ids corresponding to a list of Warehouse objects.
IdList	getWarehouseIdsByInventory(Id inventoryId) Gets the Warehouse Ids mapped to an Inventory.
WarehouseList	getWarehousesByInventory(Id inventoryId) Gets the Warehouse objects mapped to an Inventory.
void	useComparativeInventoryWarehouseView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryInventoryWarehouseView() A complete view of the Inventory and Warehouse returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupInventoryWarehouseMappings

boolean canLookupInventoryWarehouseMappings()

Tests if this user can perform lookups of inventory/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeInventoryWarehouseView

void useComparativeInventoryWarehouseView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryInventoryWarehouseView

void usePlenaryInventoryWarehouseView()

A complete view of the Inventory and Warehouse returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getInventoryIdsByWarehouse

IdList getInventoryIdsByWarehouse(Id warehouseId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the list of Inventory Ids associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related inventory Ids

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitieByWarehouse

InventoryList getActivitieByWarehouse(Id warehouseId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the list of Inventory associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related inventories

Throws:

NotFoundException - warehouseId is not found

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInventoryIdsByWarehouses

IdList getInventoryIdsByWarehouses(IdList warehouseIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the list of Inventory Ids corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of catalog Ids

Returns:

list of inventory Ids

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitieByWarehouses

InventoryList getActivitieByWarehouses(IdList warehouseIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the list of Inventories corresponding to a list of Warehouse objects.

Parameters:

warehouseIds - list of catalog Ids

Returns:

list of inventories

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseIdsByInventory

IdList getWarehouseIdsByInventory(Id inventoryId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Warehouse Ids mapped to an Inventory.

Parameters:

inventoryId - Id of an Inventory

Returns:

list of warehouses

Throws:

NotFoundException - inventoryId is not found

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehousesByInventory

WarehouseList getWarehousesByInventory(Id inventoryId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the Warehouse objects mapped to an Inventory.

Parameters:

inventoryId - Id of an Inventory

Returns:

list of warehouses

Throws:

NotFoundException - inventoryId is not found

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.