org.osid.ordering

Interface StoreForm

All Superinterfaces:

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

All Known Subinterfaces:

StoreBatchForm

public interface StoreForm
extends OsidCatalogForm

This is the form for creating and updating Stores. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the StoreAdminSession. 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
StoreFormRecord	getStoreFormRecord(Type storeRecordType) Gets the StoreFormRecord corresponding to the given store 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

getStoreFormRecord

StoreFormRecord getStoreFormRecord(Type storeRecordType)
                                   throws OperationFailedException

Gets the StoreFormRecord corresponding to the given store record Type.

Parameters:

storeRecordType - the store record type

Returns:

the store form record

Throws:

NullArgumentException - storeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storeRecordType) is false

Compliance:

mandatory - This method must be implemented.