Interface Item

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Item extends OsidObject

An Item represents a specific managed item in a warehouse.

  • Method Details

    • getStockId

      Id getStockId()
      Gets the stock Id to which this item belongs.
      Returns:
      a stock Id
      Compliance:
      mandatory - This method must be implemented.

    • getStock

      Stock getStock() throws OperationFailedException
      Gets the stock to which this item belongs.
      Returns:
      a stock
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPropertyTag

      String getPropertyTag()
      Gets the property identification number for this item.
      Returns:
      a property tag
      Compliance:
      mandatory - This method must be implemented.

    • getSerialNumber

      String getSerialNumber()
      Gets the serial number for this item.
      Returns:
      a serial number
      Compliance:
      mandatory - This method must be implemented.

    • getLocationDescription

      DisplayText getLocationDescription()
      Gets a display text for the location.
      Returns:
      a location descrption
      Compliance:
      mandatory - This method must be implemented.

    • hasLocation

      boolean hasLocation()
      Tests if this item has a known location.
      Returns:
      true if a location is associated with this item, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLocationId

      Id getLocationId()
      Gets the location Id to which this item belongs.
      Returns:
      a location Id
      Throws:
      IllegalStateException - hasLocation() is false
      Compliance:
      mandatory - This method must be implemented.

    • getLocation

      Location getLocation() throws OperationFailedException
      Gets the location to which this item belongs.
      Returns:
      a location
      Throws:
      IllegalStateException - hasLocation() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isPart

      boolean isPart()
      Tests if this item is a part of another item.
      Returns:
      true if this item is a part of another item, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getItemId

      Id getItemId()
      Gets the item Id to which this item belongs.
      Returns:
      an item Id
      Throws:
      IllegalStateException - isPart() is false
      Compliance:
      mandatory - This method must be implemented.

    • getItem

      Item getItem() throws OperationFailedException
      Gets the item to which this item belongs.
      Returns:
      an item
      Throws:
      IllegalStateException - isPart() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getItemRecord

      ItemRecord getItemRecord(Type itemRecordType) throws OperationFailedException
      Gets the item record corresponding to the given Item record Type .This method is used to retrieve an object implementing the requested record. The itemRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(itemRecordType) is true .
      Parameters:
      itemRecordType - the type of item record to retrieve
      Returns:
      the item record
      Throws:
      NullArgumentException - itemRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(itemRecordType) is false
      Compliance:
      mandatory - This method must be implemented.