org.osid.ontology

Interface OntologyForm

All Superinterfaces:

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

All Known Subinterfaces:

OntologyBatchForm

public interface OntologyForm
extends OsidCatalogForm

This is the form for creating and updating ontologies. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OntologyAdminSession. 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
OntologyFormRecord	getOntologyFormRecord(Type ontologyRecordType) Gets the OntologyFormRecord corresponding to the given ontology 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

getOntologyFormRecord

OntologyFormRecord getOntologyFormRecord(Type ontologyRecordType)
                                         throws OperationFailedException

Gets the OntologyFormRecord corresponding to the given ontology record Type.

Parameters:

ontologyRecordType - an ontology record type

Returns:

the ontology form record

Throws:

NullArgumentException - ontologyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologyRecordType) is false

Compliance:

mandatory - This method must be implemented.