org.osid.inventory

Interface ModelWarehouseSession

All Superinterfaces:

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

public interface ModelWarehouseSession
extends OsidSession

This session provides methods to retrieve Model to Warehouse mappings. A Model 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	canLookupModelWarehouseMappings() Tests if this user can perform lookups of model/warehouse mappings.
IdList	getModelIdsByWarehouse(Id warehouseId) Gets the list of Model Ids associated with a Warehouse.
IdList	getModelIdsByWarehouses(IdList warehouseIds) Gets the list of Model Ids corresponding to a list of Warehouse objects.
ModelList	getModelsByWarehouse(Id warehouseId) Gets the list of Models associated with a Warehouse.
ModelList	getModelsByWarehouses(IdList warehouseIds) Gets the list of Models corresponding to a list of Warehouse objects.
IdList	getWarehouseIdsByModel(Id modelId) Gets the Warehouse Ids mapped to a Model.
WarehouseList	getWarehousesByModel(Id modelId) Gets the Warehouse objects mapped to a Model.
void	useComparativeModelWarehouseView() 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	usePlenaryModelWarehouseView() A complete view of the Model 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

canLookupModelWarehouseMappings

boolean canLookupModelWarehouseMappings()

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

useComparativeModelWarehouseView

void useComparativeModelWarehouseView()

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.

usePlenaryModelWarehouseView

void usePlenaryModelWarehouseView()

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

getModelIdsByWarehouse

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

Gets the list of Model Ids associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

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

getModelsByWarehouse

ModelList getModelsByWarehouse(Id warehouseId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the list of Models associated with a Warehouse.

Parameters:

warehouseId - Id of the Warehouse

Returns:

list of related models

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.

getModelIdsByWarehouses

IdList getModelIdsByWarehouses(IdList warehouseIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of model Ids

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getModelsByWarehouses

ModelList getModelsByWarehouses(IdList warehouseIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

warehouseIds - list of warehouse Ids

Returns:

list of models

Throws:

NullArgumentException - warehouseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehouseIdsByModel

IdList getWarehouseIdsByModel(Id modelId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the Warehouse Ids mapped to a Model.

Parameters:

modelId - Id of a Model

Returns:

list of warehouses

Throws:

NotFoundException - modelId is not found

NullArgumentException - modelId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWarehousesByModel

WarehouseList getWarehousesByModel(Id modelId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the Warehouse objects mapped to a Model.

Parameters:

modelId - Id of a Model

Returns:

list of warehouses

Throws:

NotFoundException - modelId is not found

NullArgumentException - modelId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.