org.osid.resource

Interface BinForm

All Superinterfaces:

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

All Known Subinterfaces:

BinBatchForm

public interface BinForm
extends OsidCatalogForm

This is the form for creating and updating bins. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BinAdminSession. 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
BinFormRecord	getBinFormRecord(Type binRecordType) Gets the BinFormRecord corresponding to the given bin 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

getBinFormRecord

BinFormRecord getBinFormRecord(Type binRecordType)
                               throws OperationFailedException

Gets the BinFormRecord corresponding to the given bin record Type.

Parameters:

binRecordType - the bin record type

Returns:

the bin form record

Throws:

NullArgumentException - binRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binRecordType) is false

Compliance:

mandatory - This method must be implemented.