public interface WarehouseLookupSession extends OsidSession
This session provides methods for retrieving Warehouse
objects.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
Warehouses
it can access, without breaking execution. However, an
assessment may only be useful if all Warehouses
referenced
by it are available, and a test-taking application may sacrifice some
interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupWarehouses()
Tests if this user can perform
Warehouse lookups. |
Warehouse |
getWarehouse(Id warehouseId)
Gets the
Warehouse specified by its Id. |
WarehouseList |
getWarehouses()
Gets all
Warehouses. |
WarehouseList |
getWarehousesByGenusType(Type warehouseGenusType)
Gets a
WarehouseList corresponding to the given
warehouse genus Type which does not include warehouses
of types derived from the specified Type. |
WarehouseList |
getWarehousesByIds(IdList warehouseIds)
Gets a
WarehouseList corresponding to the given
IdList. |
WarehouseList |
getWarehousesByParentGenusType(Type warehouseGenusType)
Gets a
WarehouseList corresponding to the given
warehouse genus Type and include any additional
warehouses with genus types derived from the specified Type. |
WarehouseList |
getWarehousesByProvider(Id resourceId)
Gets a
WarehouseList for the given provider. |
WarehouseList |
getWarehousesByRecordType(Type warehouseRecordType)
Gets a
WarehouseList containing the given warehouse
record Type. |
void |
useComparativeWarehouseView()
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 |
usePlenaryWarehouseView()
A complete view of the
Warehouse returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupWarehouses()
Warehouse
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all 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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeWarehouseView()
mandatory
- This method is must be implemented. void usePlenaryWarehouseView()
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.mandatory
- This method is must be implemented. Warehouse getWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Warehouse
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Warehouse
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Warehouse
and retained for compatibility.warehouseId
- Id
of the Warehouse
NotFoundException
- warehouseId
not
foundNullArgumentException
- warehouseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. WarehouseList getWarehousesByIds(IdList warehouseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
WarehouseList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
warehouses specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Warehouses
may be omitted from the list
and may present the elements in any order including returning a unique
set.warehouseIds
- the list of Ids
to retrieve Warehouse
listNotFoundException
- an Id
was not foundNullArgumentException
- warehouseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByGenusType(Type warehouseGenusType) throws OperationFailedException, PermissionDeniedException
WarehouseList
corresponding to the given
warehouse genus Type
which does not include warehouses
of types derived from the specified Type.
In plenary
mode, the returned list contains all known warehouses or an error
results. Otherwise, the returned list may contain only those
warehouses that are accessible through this session.warehouseGenusType
- a warehouse genus type Warehouse
listNullArgumentException
- warehouseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByParentGenusType(Type warehouseGenusType) throws OperationFailedException, PermissionDeniedException
WarehouseList
corresponding to the given
warehouse genus Type
and include any additional
warehouses with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
warehouses or an error results. Otherwise, the returned list may
contain only those warehouses that are accessible through this
session.warehouseGenusType
- a warehouse genus type Warehouse
listNullArgumentException
- warehouseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByRecordType(Type warehouseRecordType) throws OperationFailedException, PermissionDeniedException
WarehouseList
containing the given warehouse
record Type.
In plenary mode, the returned list
contains all known warehouses or an error results. Otherwise, the
returned list may contain only those warehouses that are accessible
through this session.warehouseRecordType
- a warehouse record type Warehouse
listNullArgumentException
- warehouseRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehousesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
WarehouseList
for the given provider.
In plenary mode, the returned list contains all known
warehouses or an error results. Otherwise, the returned list may
contain only those warehouses that are accessible through this
session.resourceId
- a resource Id
Warehouse
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WarehouseList getWarehouses() throws OperationFailedException, PermissionDeniedException
Warehouses.
In plenary mode, the returned list
contains all known warehouses or an error results. Otherwise, the
returned list may contain only those warehouses that are accessible
through this session. Warehouses
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.