org.osid.inquiry

Interface InquestForm

All Superinterfaces:

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

All Known Subinterfaces:

InquestBatchForm

public interface InquestForm
extends OsidCatalogForm

This is the form for creating and updating inquests. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InquestAdminSession. 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
InquestFormRecord	getInquestFormRecord(Type inquestRecordType) Gets the InquestFormRecord corresponding to the given inquest 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

getInquestFormRecord

InquestFormRecord getInquestFormRecord(Type inquestRecordType)
                                       throws OperationFailedException

Gets the InquestFormRecord corresponding to the given inquest record Type.

Parameters:

inquestRecordType - an inquest record type

Returns:

the inquest form record

Throws:

NullArgumentException - inquestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquestRecordType) is false

Compliance:

mandatory - This method must be implemented.