org.osid.inventory

Interface ModelForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

ModelBatchForm

public interface ModelForm
extends OsidObjectForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearArchetype() Removes the archetype.
void	clearManufacturer() Removes the manufacturer.
void	clearNumber() Removes the model number.
Metadata	getArchetypeMetadata() Gets the metadata for the archetype.
Metadata	getManufacturerMetadata() Gets the metadata for the manufacturer.
ModelFormRecord	getModelFormRecord(Type modelRecordType) Gets the ModelFormRecord corresponding to the given model record Type.
Metadata	getNumberMetadata() Gets the metadata for the model number.
void	setArchetype(java.lang.String archetype) Sets the archetype.
void	setManufacturer(Id resourceId) Sets the manufacturer.
void	setNumber(java.lang.String number) Sets the model number.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getManufacturerMetadata

Metadata getManufacturerMetadata()

Gets the metadata for the manufacturer.

Returns:

metadata for the manufacturer

Compliance:

mandatory - This method must be implemented.

setManufacturer

void setManufacturer(Id resourceId)

Sets the manufacturer.

Parameters:

resourceId - the new resource

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearManufacturer

void clearManufacturer()

Removes the manufacturer.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getArchetypeMetadata

Metadata getArchetypeMetadata()

Gets the metadata for the archetype.

Returns:

metadata for the archetype

Compliance:

mandatory - This method must be implemented.

setArchetype

void setArchetype(java.lang.String archetype)

Sets the archetype.

Parameters:

archetype - the new archetype

Throws:

InvalidArgumentException - archetype is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - archetype is null

Compliance:

mandatory - This method must be implemented.

clearArchetype

void clearArchetype()

Removes the archetype.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getNumberMetadata

Metadata getNumberMetadata()

Gets the metadata for the model number.

Returns:

metadata for the model number

Compliance:

mandatory - This method must be implemented.

setNumber

void setNumber(java.lang.String number)

Sets the model number.

Parameters:

number - the new model number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearNumber

void clearNumber()

Removes the model number.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getModelFormRecord

ModelFormRecord getModelFormRecord(Type modelRecordType)
                                   throws OperationFailedException

Gets the ModelFormRecord corresponding to the given model record Type.

Parameters:

modelRecordType - a model record type

Returns:

the model form record

Throws:

NullArgumentException - modelRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(modelRecordType) is false

Compliance:

mandatory - This method must be implemented.