org.osid.ordering

Interface ItemForm

All Superinterfaces:

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

All Known Subinterfaces:

ItemBatchForm

public interface ItemForm
extends OsidRelationshipForm

This is the form for creating and updating Items. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ItemAdminSession. 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	clearQuantity() Clears the quantity.
ItemFormRecord	getItemFormRecord(Type itemRecordType) Gets the ItemFormRecord corresponding to the given item record Type.
Metadata	getQuantityMetadata() Gets the metadata for a quantity.
void	setQuantity(long 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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getQuantityMetadata

Metadata getQuantityMetadata()

Gets the metadata for a quantity.

Returns:

metadata for the quantity

Compliance:

mandatory - This method must be implemented.

setQuantity

void setQuantity(long 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()

Clears the quantity.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getItemFormRecord

ItemFormRecord getItemFormRecord(Type itemRecordType)
                                 throws OperationFailedException

Gets the ItemFormRecord corresponding to the given item record Type.

Parameters:

itemRecordType - the item record type

Returns:

the item form record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.