Interface WarehouseLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface WarehouseLookupSession extends OsidSession

This session provides methods for retrieving Warehouses .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

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.

  • Method Details

    • canLookupWarehouses

      boolean canLookupWarehouses()
      Tests if this user can perform 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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeWarehouseView

      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. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryWarehouseView

      void usePlenaryWarehouseView()
      A complete view of the 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.

    • getWarehouse

      Warehouse getWarehouse(Id warehouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the 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.
      Parameters:
      warehouseId - Id of the Warehouse
      Returns:
      the warehouse
      Throws:
      NotFoundException - warehouseId not found
      NullArgumentException - warehouseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getWarehousesByIds

      WarehouseList getWarehousesByIds(IdList warehouseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      warehouseIds - the list of Ids to retrieve
      Returns:
      the returned Warehouse list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - warehouseIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getWarehousesByGenusType

      WarehouseList getWarehousesByGenusType(Type warehouseGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      warehouseGenusType - a warehouse genus type
      Returns:
      the returned Warehouse list
      Throws:
      NullArgumentException - warehouseGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getWarehousesByParentGenusType

      WarehouseList getWarehousesByParentGenusType(Type warehouseGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      warehouseGenusType - a warehouse genus type
      Returns:
      the returned Warehouse list
      Throws:
      NullArgumentException - warehouseGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getWarehousesByRecordType

      WarehouseList getWarehousesByRecordType(Type warehouseRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      warehouseRecordType - a warehouse record type
      Returns:
      the returned Warehouse list
      Throws:
      NullArgumentException - warehouseRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getWarehousesByProvider

      WarehouseList getWarehousesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Warehouse list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouses

      WarehouseList getWarehouses() throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Returns:
      a list of Warehouses
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.