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 OsidForms, 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

Modifier and Type	Method	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(String archetype)	Sets the archetype.
void	setManufacturer(Id resourceId)	Sets the manufacturer.
void	setNumber(String number)	Sets the model number.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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(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(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.