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

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

MethodgetManufacturerMetadata
Description

Gets the metadata for the manufacturer.

Returnosid.Metadatametadata for the manufacturer
CompliancemandatoryThis method must be implemented.
MethodsetManufacturer
Description

Sets the manufacturer.

Parametersosid.id.IdresourceIdthe new resource
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearManufacturer
Description

Removes the manufacturer.

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

Gets the metadata for the archetype.

Returnosid.Metadatametadata for the archetype
CompliancemandatoryThis method must be implemented.
MethodsetArchetype
Description

Sets the archetype.

Parametersstringarchetypethe new archetype
ErrorsINVALID_ARGUMENT archetype is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT archetype is null
CompliancemandatoryThis method must be implemented.
MethodclearArchetype
Description

Removes the archetype.

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

Gets the metadata for the model number.

Returnosid.Metadatametadata for the model number
CompliancemandatoryThis method must be implemented.
MethodsetNumber
Description

Sets the model number.

Parametersstringnumberthe new model number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearNumber
Description

Removes the model number.

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

Gets the ModelFormRecord corresponding to the given model record Type.

Parametersosid.type.TypemodelRecordTypea model record type
Returnosid.inventory.records.ModelFormRecordthe model form record
ErrorsNULL_ARGUMENT modelRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(modelRecordType) is false
CompliancemandatoryThis method must be implemented.