Interface | osid.inventory.StockForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
osid.OsidFederateableForm | |||
Description |
This is the form for creating and updating | ||
Method | getSKUMetadata | ||
Description |
Gets the metadata for sku. | ||
Return | osid.Metadata | metadata for the sku | |
Compliance | mandatory | This method must be implemented. | |
Method | setSKU | ||
Description |
Sets the SKU. | ||
Parameters | string | sku | the new SKU |
Errors | INVALID_ARGUMENT | sku is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | sku is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSKU | ||
Description |
Removes the SKU. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelsMetadata | ||
Description |
Gets the metadata for models in this stock. | ||
Return | osid.Metadata | metadata for the models | |
Compliance | mandatory | This method must be implemented. | |
Method | setModels | ||
Description |
Sets the models. | ||
Parameters | osid.id.Id[] | models | the new models |
Errors | INVALID_ARGUMENT | models is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | models is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearModels | ||
Description |
Removes the models. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationDescriptionMetadata | ||
Description |
Gets the metadata for location string. | ||
Return | osid.Metadata | metadata for the location string | |
Compliance | mandatory | This method must be implemented. | |
Method | setLocationDescription | ||
Description |
Sets the location string. | ||
Parameters | string | location | the new location description |
Errors | INVALID_ARGUMENT | location is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | location is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearLocationDescription | ||
Description |
Removes the location description. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsMetadata | ||
Description |
Gets the metadata for locations in this stock. | ||
Return | osid.Metadata | metadata for the locations | |
Compliance | mandatory | This method must be implemented. | |
Method | setLocations | ||
Description |
Sets the locations. | ||
Parameters | osid.id.Id[] | locations | the new locations |
Errors | INVALID_ARGUMENT | locations is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | locations is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearLocations | ||
Description |
Removes the locations. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | stockRecordType | a stock record type |
Return | osid.inventory.records.StockFormRecord | the stock form record | |
Errors | NULL_ARGUMENT | stockRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stockRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |