org.osid.relationship

Interface FamilyForm

All Superinterfaces:

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

All Known Subinterfaces:

FamilyBatchForm

public interface FamilyForm
extends OsidCatalogForm

This is the form for creating and updating Family objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FamilyAdminSession. 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
FamilyFormRecord	getFamilyFormRecord(Type familyRecordType) Gets the FamilyFormRecord corresponding to the given family 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

getFamilyFormRecord

FamilyFormRecord getFamilyFormRecord(Type familyRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the FamilyFormRecord corresponding to the given family record Type.

Parameters:

familyRecordType - the family record type

Returns:

the family form record

Throws:

NullArgumentException - familyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(familyRecordType) is false

Compliance:

mandatory - This method must be implemented.