Interface InventoryWarehouseSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.