org.osid.topology

Interface GraphForm

All Superinterfaces:

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

All Known Subinterfaces:

GraphBatchForm

public interface GraphForm
extends OsidCatalogForm

This is the form for creating and updating graphs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the GraphAdminSession. 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
GraphFormRecord	getGraphFormRecord(Type graphRecordType) Gets the GraphFormRecord corresponding to the given graph 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

getGraphFormRecord

GraphFormRecord getGraphFormRecord(Type graphRecordType)
                                   throws OperationFailedException

Gets the GraphFormRecord corresponding to the given graph record Type.

Parameters:

graphRecordType - a graph record type

Returns:

the graph form record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.