org.osid.provisioning

Interface DistributorForm

All Superinterfaces:

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

All Known Subinterfaces:

DistributorBatchForm

public interface DistributorForm
extends OsidCatalogForm

This is the form for creating and updating distributors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DistributorAdminSession. 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
DistributorFormRecord	getDistributorFormRecord(Type distributorRecordType) Gets the DistributorFormRecord corresponding to the given distributor 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

getDistributorFormRecord

DistributorFormRecord getDistributorFormRecord(Type distributorRecordType)
                                               throws OperationFailedException

Gets the DistributorFormRecord corresponding to the given distributor record Type.

Parameters:

distributorRecordType - a distributor record type

Returns:

the distributor form record

Throws:

NullArgumentException - distributorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorRecordType) is false

Compliance:

mandatory - This method must be implemented.