org.osid.inventory

Interface ItemWarehouseSession

All Superinterfaces:

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

public interface ItemWarehouseSession
extends OsidSession

This session provides methods to retrieve Item to Warehouse mappings. An Item 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	canLookupItemWarehouseMappings() Tests if this user can perform lookups of item/warehouse mappings.
IdList	getItemIdsByWarehouse(Id warehouseId) Gets the list of Item Ids associated with a Warehouse.
IdList	getItemIdsByWarehouses(IdList warehouseIds) Gets the list of Item Ids corresponding to a list of Warehouse objects.
ItemList	getItemsByWarehouse(Id warehouseId) Gets the list of Items associated with a Warehouse.
ItemList	getItemsByWarehouses(IdList warehouseIds) Gets the list of Items corresponding to a list of Warehouse objects.
IdList	getWarehouseIdsByItem(Id itemId) Gets the Warehouse Ids mapped to an Item.
WarehouseList	getWarehousesByItem(Id itemId) Gets the Warehouse objects mapped to an Item.
void	useComparativeItemWarehouseView() 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	usePlenaryItemCatalogView() A complete view of the Item 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

canLookupItemWarehouseMappings

boolean canLookupItemWarehouseMappings()

Tests if this user can perform lookups of item/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.

useComparativeItemWarehouseView

void useComparativeItemWarehouseView()

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.

usePlenaryItemCatalogView

void usePlenaryItemCatalogView()

A complete view of the Item 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.

getItemIdsByWarehouse

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

Gets the list of Item Ids associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related item 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.

getItemsByWarehouse

ItemList getItemsByWarehouse(Id warehouseId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the list of Items associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related items

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.

getItemIdsByWarehouses

IdList getItemIdsByWarehouses(IdList warehouseIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of item Ids

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getItemsByWarehouses

ItemList getItemsByWarehouses(IdList warehouseIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of items

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseIdsByItem

IdList getWarehouseIdsByItem(Id itemId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Warehouse Ids mapped to an Item.

Parameters:

itemId - Id of an Item

Returns:

list of warehouses

Throws:

NotFoundException - itemId is not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehousesByItem

WarehouseList getWarehousesByItem(Id itemId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Warehouse objects mapped to an Item.

Parameters:

itemId - Id of an Item

Returns:

list of warehouses

Throws:

NotFoundException - itemId is not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.