org.osid.inventory

Interface WarehouseForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

public interface WarehouseForm
extends OsidCatalogForm

This is the form for creating and updating warehouses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the WarehouseAdminSession. 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
WarehouseFormRecord	getWarehouseFormRecord(Type warehouseRecordType) Gets the WarehouseFormRecord corresponding to the given warehouse record Type.

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.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getWarehouseFormRecord

WarehouseFormRecord getWarehouseFormRecord(Type warehouseRecordType)
                                           throws OperationFailedException

Gets the WarehouseFormRecord corresponding to the given warehouse record Type.

Parameters:

warehouseRecordType - a warehouse record type

Returns:

the warehouse form record

Throws:

NullArgumentException - warehouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(warehouseRecordType) is false

Compliance:

mandatory - This method must be implemented.