org.osid.inventory

Interface InventoryForm

All Superinterfaces:

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

All Known Subinterfaces:

InventoryBatchForm

public interface InventoryForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Inventories. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InventoryAdminSession. 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	clearDate() Removes the date.
void	clearQuantity() Removes the quantity.
Metadata	getDateMetadata() Gets the metadata for the date.
InventoryFormRecord	getInventoryFormRecord(Type inventoryRecordType) Gets the InventoryFormRecord corresponding to the given inventory record Type.
Metadata	getQuantityMetadata() Gets the metadata for the quantity.
void	setDate(DateTime date) Sets the date.
void	setQuantity(java.math.BigDecimal quantity) Sets the quantity.

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

getDateMetadata

Metadata getDateMetadata()

Gets the metadata for the date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setDate

void setDate(DateTime date)

Sets the date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDate

void clearDate()

Removes the date.

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

getInventoryFormRecord

InventoryFormRecord getInventoryFormRecord(Type inventoryRecordType)
                                           throws OperationFailedException

Gets the InventoryFormRecord corresponding to the given inventory record Type.

Parameters:

inventoryRecordType - an inventory record type

Returns:

the inventory form record

Throws:

NullArgumentException - inventoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventoryRecordType) is false

Compliance:

mandatory - This method must be implemented.