Interface EntryForm

All Superinterfaces:

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

All Known Subinterfaces:

EntryBatchForm

public interface EntryForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Entries. Like all OsidForms, various data elements may be set here for use in the create and update methods in the EntryAdminSession. 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	clearItem()	Removes the item.
void	clearModel()	Removes the model.
void	clearQuantity()	Removes the quantity.
void	clearUnitType()	Removes the unit type.
EntryFormRecord	getEntryFormRecord(Type entryRecordType)	Gets the EntryFormRecord corresponding to the given entry record Type.
Metadata	getItemMetadata()	Gets the metadata for an item.
Metadata	getModelMetadata()	Gets the metadata for a model.
Metadata	getQuantityMetadata()	Gets the metadata for the quantity.
Metadata	getUnitTypeMetadata()	Gets the metadata for the unit type.
void	setItem(Id itemId)	Sets the item.
void	setModel(Id modelId)	Sets the model.
void	setQuantity(BigDecimal quantity)	Sets the quantity.
void	setUnitType(Type type)	Sets the unit type.

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

getModelMetadata

Metadata getModelMetadata()

Gets the metadata for a model.

Returns:

metadata for the model

Compliance:

mandatory - This method must be implemented.

setModel

void setModel(Id modelId)

Sets the model.

Parameters:

modelId - the new model

Throws:

InvalidArgumentException - modelId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - modelId is null

Compliance:

mandatory - This method must be implemented.

clearModel

void clearModel()

Removes the model.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getItemMetadata

Metadata getItemMetadata()

Gets the metadata for an item.

Returns:

metadata for the item

Compliance:

mandatory - This method must be implemented.

setItem

void setItem(Id itemId)

Sets the item.

Parameters:

itemId - the new item

Throws:

InvalidArgumentException - itemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - itemId is null

Compliance:

mandatory - This method must be implemented.

clearItem

void clearItem()

Removes the item.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getQuantityMetadata

Metadata getQuantityMetadata()

Gets the metadata for the quantity.

Returns:

metadata for the quantity

Compliance:

mandatory - This method must be implemented.

setQuantity

void setQuantity(BigDecimal quantity)

Sets the quantity.

Parameters:

quantity - the new quantity

Throws:

InvalidArgumentException - quantity is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearQuantity

void clearQuantity()

Removes the quantity.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getUnitTypeMetadata

Metadata getUnitTypeMetadata()

Gets the metadata for the unit type.

Returns:

metadata for the unit type

Compliance:

mandatory - This method must be implemented.

setUnitType

void setUnitType(Type type)

Sets the unit type.

Parameters:

type - the new unit type

Throws:

InvalidArgumentException - type is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - type is null

Compliance:

mandatory - This method must be implemented.

clearUnitType

void clearUnitType()

Removes the unit type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEntryFormRecord

EntryFormRecord getEntryFormRecord(Type entryRecordType)
                            throws OperationFailedException

Gets the EntryFormRecord corresponding to the given entry record Type.

Parameters:

entryRecordType - an entry record type

Returns:

the entry form record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.