org.osid.inventory

Interface Item

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Item
extends OsidObject

An Item represents a particular item.

Method Summary

Methods

Modifier and Type	Method and Description
Item	getItem() Gets the item to which this item belongs.
Id	getItemId() Gets the item Id to which this item belongs.
ItemRecord	getItemRecord(Type itemRecordType) Gets the item record corresponding to the given Item record Type.
Location	getLocation() Gets the location to which this item belongs.
DisplayText	getLocationDescription() Gets a display string for the location.
Id	getLocationId() Gets the location Id to which this item belongs.
java.lang.String	getPropertyTag() Gets the property identification number for this item.
java.lang.String	getSerialNumber() Gets the serial number for this item.
Stock	getStock() Gets the stock to which this item belongs.
Id	getStockId() Gets the stock Id to which this item belongs.
boolean	hasLocation() Tests if this item has a known location.
boolean	isPart() Tests if this item is a part of another item.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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

java.lang.String getPropertyTag()

Gets the property identification number for this item.

Returns:

a property tag

Compliance:

mandatory - This method must be implemented.

getSerialNumber

java.lang.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 string 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:

a 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:

a 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.