OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating Items. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ItemAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetStockMetadata
Description

Gets the metadata for stock.

Returnosid.Metadatametadata for the stock
CompliancemandatoryThis method must be implemented.
MethodsetStock
Description

Sets the stock Id.

Parametersosid.id.IdstockIdthe new stock
ErrorsINVALID_ARGUMENT stockId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stockId is null
CompliancemandatoryThis method must be implemented.
MethodclearStock
Description

Removes the stock.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPropertyTagMetadata
Description

Gets the metadata for serial number.

Returnosid.Metadatametadata for the serial number
CompliancemandatoryThis method must be implemented.
MethodsetPropertyTag
Description

Sets the property tag.

Parametersstringpropertythe new property tag
ErrorsINVALID_ARGUMENT property is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT property is null
CompliancemandatoryThis method must be implemented.
MethodclearPropertyTag
Description

Removes the property tag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSerialNumberMetadata
Description

Gets the metadata for serial number.

Returnosid.Metadatametadata for the serial number
CompliancemandatoryThis method must be implemented.
MethodsetSerialNumber
Description

Sets the serial number.

Parametersstringserialthe new serial number
ErrorsINVALID_ARGUMENT serial is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT serial is null
CompliancemandatoryThis method must be implemented.
MethodclearSerialNumber
Description

Removes the serial number.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLocationDescriptionMetadata
Description

Gets the metadata for location description.

Returnosid.Metadatametadata for the location description
CompliancemandatoryThis method must be implemented.
MethodsetLocationDescription
Description

Sets the location description.

Parametersstringlocationthe new location description
ErrorsINVALID_ARGUMENT location is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT location is null
CompliancemandatoryThis method must be implemented.
MethodclearLocationDescription
Description

Removes the location description.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLocationMetadata
Description

Gets the metadata for location.

Returnosid.Metadatametadata for the location
CompliancemandatoryThis method must be implemented.
MethodsetLocation
Description

Sets the location.

ParametersstringlocationIdthe new location
ErrorsINVALID_ARGUMENT locationId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearLocation
Description

Removes the location.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetItemMetadata
Description

Gets the metadata for the item.

Returnosid.Metadatametadata for the locitemation
CompliancemandatoryThis method must be implemented.
MethodsetItem
Description

Sets the item to which this item is a part.

Parametersosid.id.IditemIdthe new parent item
ErrorsINVALID_ARGUMENT itemId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItem
Description

Removes the item.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetItemFormRecord
Description

Gets the ItemFormRecord corresponding to the given item record Type.

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.inventory.records.ItemFormRecordthe item form record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.