org.osid.inventory.batch

Interface InventoryBatchForm

All Superinterfaces:

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

public interface InventoryBatchForm
extends InventoryForm

This is the form for creating and updating inventories in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InventoryBatchAdminSession. 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	clearParents() Removes the hierarchical parents.
Id	getInventoryId() Gets the Inventory Id of the inventory to be updated if this is an update transaction.
Metadata	getParentsMetadata() Gets the metadata for setting the hierarchical parents of this inventory.
void	setParents(Id[] parents) Sets the hierarchical parents.

Methods inherited from interface org.osid.inventory.InventoryForm

clearDate, clearQuantity, getDateMetadata, getInventoryFormRecord, getQuantityMetadata, setDate, setQuantity

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

getInventoryId

Id getInventoryId()

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

Returns:

the inventory Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.

getParentsMetadata

Metadata getParentsMetadata()

Gets the metadata for setting the hierarchical parents of this inventory.

Returns:

metadata for the parents

Compliance:

mandatory - This method must be implemented.

setParents

void setParents(Id[] parents)

Sets the hierarchical parents.

Parameters:

parents - the new parents

Throws:

InvalidArgumentException - parents is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - parents is null

Compliance:

mandatory - This method must be implemented.

clearParents

void clearParents()

Removes the hierarchical parents.

Throws:

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

Compliance:

mandatory - This method must be implemented.