org.osid.topology

Interface NodeForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

NodeBatchForm

public interface NodeForm
extends OsidObjectForm

This is the form for creating and updating Nodes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the NodeAdminSession. 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
NodeFormRecord	getNodeFormRecord(Type nodeRecordType) Gets the NodeFormRecord corresponding to the given node 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

Method Detail

getNodeFormRecord

NodeFormRecord getNodeFormRecord(Type nodeRecordType)
                                 throws OperationFailedException

Gets the NodeFormRecord corresponding to the given node record Type.

Parameters:

nodeRecordType - a node record type

Returns:

the node form record

Throws:

NullArgumentException - nodeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeRecordType) is false

Compliance:

mandatory - This method must be implemented.