org.osid.sequencing

Interface AntimatroidForm

All Superinterfaces:

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

public interface AntimatroidForm
extends OsidCatalogForm

This is the form for creating and updating antimatroids. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AntimatroidAdminSession. 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
AntimatroidFormRecord	getAntimatroidFormRecord(Type antimatroidRecordType) Gets the AntimatroidFormRecord corresponding to the given antimatroid 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

getAntimatroidFormRecord

AntimatroidFormRecord getAntimatroidFormRecord(Type antimatroidRecordType)
                                               throws OperationFailedException

Gets the AntimatroidFormRecord corresponding to the given antimatroid record Type.

Parameters:

antimatroidRecordType - an antimatroid record type

Returns:

the antimatroid form record

Throws:

NullArgumentException - antimatroidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(antimatroidRecordType) is false

Compliance:

mandatory - This method must be implemented.