org.osid.mapping.path

Interface PathForm

All Superinterfaces:

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

All Known Subinterfaces:

PathBatchForm

public interface PathForm
extends OsidObjectForm

This is the form for creating and updating Paths. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PathAdminSession. 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
PathFormRecord	getPathFormRecord(Type pathRecordType) Gets the PathFormRecord corresponding to the given path 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

getPathFormRecord

PathFormRecord getPathFormRecord(Type pathRecordType)
                                 throws OperationFailedException

Gets the PathFormRecord corresponding to the given path record Type.

Parameters:

pathRecordType - a path record type

Returns:

the path form record

Throws:

NullArgumentException - pathRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathRecordType) is false

Compliance:

mandatory - This method must be implemented.