org.osid.subscription

Interface DispatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

DispatchBatchForm

public interface DispatchForm
extends OsidGovernatorForm

This is the form for creating and updating Dispatches. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DispatchAdminSession. 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
DispatchFormRecord	getDispatchFormRecord(Type dispatchRecordType) Gets the DispatchFormRecord corresponding to the given dispatch 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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getDispatchFormRecord

DispatchFormRecord getDispatchFormRecord(Type dispatchRecordType)
                                         throws OperationFailedException

Gets the DispatchFormRecord corresponding to the given dispatch record Type.

Parameters:

dispatchRecordType - the dispatch record type

Returns:

the dispatch form record

Throws:

NullArgumentException - dispatchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchRecordType) is false

Compliance:

mandatory - This method must be implemented.