org.osid.subscription

Interface PublisherForm

All Superinterfaces:

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

All Known Subinterfaces:

PublisherBatchForm

public interface PublisherForm
extends OsidCatalogForm

This is the form for creating and updating Publishers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PublisherAdminSession. 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
PublisherFormRecord	getPublisherFormRecord(Type publisherRecordType) Gets the PublisherFormRecord corresponding to the given publisher 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

getPublisherFormRecord

PublisherFormRecord getPublisherFormRecord(Type publisherRecordType)
                                           throws OperationFailedException

Gets the PublisherFormRecord corresponding to the given publisher record Type.

Parameters:

publisherRecordType - the publisher record type

Returns:

the publisher form record

Throws:

NullArgumentException - publisherRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publisherRecordType) is false

Compliance:

mandatory - This method must be implemented.