Interface | osid.inventory.Item | ||
---|---|---|---|
Implements | osid.OsidObject | ||
Description |
An | ||
Method | getStockId | ||
Description |
Gets the stock | ||
Return | osid.id.Id | a stock Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getStock | ||
Description |
Gets the stock to which this item belongs. | ||
Return | osid.inventory.Stock | a stock | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getPropertyTag | ||
Description |
Gets the property identification number for this item. | ||
Return | string | a property tag | |
Compliance | mandatory | This method must be implemented. | |
Method | getSerialNumber | ||
Description |
Gets the serial number for this item. | ||
Return | string | a serial number | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationDescription | ||
Description |
Gets a display string for the location. | ||
Return | osid.locale.DisplayText | a location descrption | |
Compliance | mandatory | This method must be implemented. | |
Method | hasLocation | ||
Description |
Tests if this item has a known location. | ||
Return | boolean | true if a location is associated with this item,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationId | ||
Description |
Gets the location | ||
Return | osid.id.Id | a location Id | |
Errors | ILLEGAL_STATE | hasLocation() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocation | ||
Description |
Gets the location to which this item belongs. | ||
Return | osid.mapping.Location | a location | |
Errors | ILLEGAL_STATE | hasLocation() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isPart | ||
Description |
Tests if this item is a part of another item. | ||
Return | boolean | true if this item is a part of another item, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemId | ||
Description |
Gets the item | ||
Return | osid.id.Id | a item Id | |
Errors | ILLEGAL_STATE | isPart() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getItem | ||
Description |
Gets the item to which this item belongs. | ||
Return | osid.inventory.Item | a item | |
Errors | ILLEGAL_STATE | isPart() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemRecord | ||
Description |
Gets the item record corresponding to the given | ||
Parameters | osid.type.Type | itemRecordType | the type of item record to retrieve |
Return | osid.inventory.records.ItemRecord | the item record | |
Errors | NULL_ARGUMENT | itemRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(itemRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |