org.osid.hierarchy

Interface HierarchyForm

All Superinterfaces:

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

public interface HierarchyForm
extends OsidCatalogForm

This is the form for creating and updating Hierarchy objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the HierarchyAdminSession. 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
HierarchyFormRecord	getHierarchyFormRecord(Type hierarchyRecordType) Gets the HierarchyFormRecord corresponding to the given hierarchy 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

getHierarchyFormRecord

HierarchyFormRecord getHierarchyFormRecord(Type hierarchyRecordType)
                                           throws OperationFailedException

Gets the HierarchyFormRecord corresponding to the given hierarchy record Type.

Parameters:

hierarchyRecordType - the hierarchy record type

Returns:

the hierarchy form record

Throws:

NullArgumentException - hierarchyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchyRecordType) is false

Compliance:

mandatory - This method must be implemented.