Interface ItemBatchForm

All Superinterfaces:

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

public interface ItemBatchForm
extends ItemForm

This is the form for creating and updating items in bulk. Like all OsidForms , various data elements may be set here for use in the create and update methods in the ItemBatchAdminSession . 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
Id	getItemId()	Gets the Id of the item to be updated if this is an update transaction.

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 ItemForm

clearItem, clearLocation, clearLocationDescription, clearPropertyTag, clearSerialNumber, clearStock, getItemFormRecord, getItemMetadata, getLocationDescriptionMetadata, getLocationMetadata, getPropertyTagMetadata, getSerialNumberMetadata, getStockMetadata, setItem, setLocation, setLocationDescription, setPropertyTag, setSerialNumber, setStock

Modifier and Type	Method	Description
void	clearItem()	Removes the item.
void	clearLocation()	Removes the location.
void	clearLocationDescription()	Removes the location description.
void	clearPropertyTag()	Removes the property tag.
void	clearSerialNumber()	Removes the serial number.
void	clearStock()	Removes the stock.
ItemFormRecord	getItemFormRecord(Type itemRecordType)	Gets the ItemFormRecord corresponding to the given item record Type .
Metadata	getItemMetadata()	Gets the metadata for the item.
Metadata	getLocationDescriptionMetadata()	Gets the metadata for location description.
Metadata	getLocationMetadata()	Gets the metadata for location.
Metadata	getPropertyTagMetadata()	Gets the metadata for serial number.
Metadata	getSerialNumberMetadata()	Gets the metadata for serial number.
Metadata	getStockMetadata()	Gets the metadata for stock.
void	setItem(Id itemId)	Sets the item to which this item is a part.
void	setLocation(Id locationId)	Sets the location.
void	setLocationDescription(String location)	Sets the location description.
void	setPropertyTag(String property)	Sets the property tag.
void	setSerialNumber(String serial)	Sets the serial number.
void	setStock(Id stockId)	Sets the stock Id .

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

getItemId

Id getItemId()

Gets the Id of the item to be updated if this is an update transaction.

Returns:

the item Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.