org.osid.inventory

Interface ModelWarehouseAssignmentSession

All Superinterfaces:

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

public interface ModelWarehouseAssignmentSession
extends OsidSession

This session provides methods to re-assign Models to Warehouse objects A Model may appear in multiple Warehouse objects and removing the last reference to a Model is the equivalent of deleting it. Each Warehouse may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Model to another Warehouse is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignModelToWarehouse(Id modelId, Id warehouseId) Adds an existing Model to a Warehouse.
boolean	canAssignModels() Tests if this user can alter model/warehouse mappings.
boolean	canAssignModelToWarehouse(Id warehouseId) Tests if this user can alter model/warehouse mappings.
IdList	getAssignableWarehouseIds(Id warehouseId) Gets a list of warehouses including and under the given warehouse node in which any model can be assigned.
IdList	getAssignableWarehouseIdsForModel(Id warehouseId, Id modelId) Gets a list of warehouses including and under the given warehouse node in which a specific model can be assigned.
void	unassignModelFromWarehouse(Id modelId, Id warehouseId) Removes a Model from a Warehouse.

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

canAssignModels

boolean canAssignModels()

Tests if this user can alter model/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignModelToWarehouse

boolean canAssignModelToWarehouse(Id warehouseId)

Tests if this user can alter model/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - warehouseId is null

Compliance:

mandatory - This method must be implemented.

getAssignableWarehouseIds

IdList getAssignableWarehouseIds(Id warehouseId)
                                 throws OperationFailedException

Gets a list of warehouses including and under the given warehouse node in which any model can be assigned.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

list of assignable warehouse Ids

Throws:

NullArgumentException - warehouseId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableWarehouseIdsForModel

IdList getAssignableWarehouseIdsForModel(Id warehouseId,
                                       Id modelId)
                                         throws OperationFailedException

Gets a list of warehouses including and under the given warehouse node in which a specific model can be assigned.

Parameters:

warehouseId - the Id of the Warehouse

modelId - the Id of the Model

Returns:

list of assignable warehouse Ids

Throws:

NullArgumentException - warehouseId or modelId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignModelToWarehouse

void assignModelToWarehouse(Id modelId,
                          Id warehouseId)
                            throws AlreadyExistsException,
                                   NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Adds an existing Model to a Warehouse.

Parameters:

modelId - the Id of the Model

warehouseId - the Id of the Warehouse

Throws:

AlreadyExistsException - modelId is already assigned to warehouseId

NotFoundException - modelId or warehouseId not found

NullArgumentException - modelId or warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignModelFromWarehouse

void unassignModelFromWarehouse(Id modelId,
                              Id warehouseId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Removes a Model from a Warehouse.

Parameters:

modelId - the Id of the Model

warehouseId - the Id of the Warehouse

Throws:

NotFoundException - modelId or warehouseId not found or modelId not assigned to warehouseId

NullArgumentException - modelId or warehouseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.