org.osid.assessment

Interface BankForm

All Superinterfaces:

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

All Known Subinterfaces:

BankBatchForm

public interface BankForm
extends OsidCatalogForm

This is the form for creating and updating banks. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BankAdminSession. 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
BankFormRecord	getBankFormRecord(Type bankRecordType) Gets the BankFormRecord corresponding to the given bank 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

getBankFormRecord

BankFormRecord getBankFormRecord(Type bankRecordType)
                                 throws OperationFailedException

Gets the BankFormRecord corresponding to the given bank record Type.

Parameters:

bankRecordType - a bank record type

Returns:

the bank record

Throws:

NullArgumentException - bankRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bankRecordType) is false

Compliance:

mandatory - This method must be implemented.