org.osid.offering

Interface CatalogueForm

All Superinterfaces:

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

All Known Subinterfaces:

CatalogueBatchForm

public interface CatalogueForm
extends OsidCatalogForm

This is the form for creating and updating Catalogues. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CatalogueAdminSession. 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
CatalogueFormRecord	getCatalogueFormRecord(Type catalogueRecordType) Gets the CatalogueFormRecord interface corresponding to the given catalogue 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

getCatalogueFormRecord

CatalogueFormRecord getCatalogueFormRecord(Type catalogueRecordType)
                                           throws OperationFailedException

Gets the CatalogueFormRecord interface corresponding to the given catalogue record Type.

Parameters:

catalogueRecordType - the catalogue record type

Returns:

the record

Throws:

NullArgumentException - catalogueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueRecordType) is false

Compliance:

mandatory - This method must be implemented.