org.osid.room.squatting

Interface DeedForm

All Superinterfaces:

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

All Known Subinterfaces:

DeedBatchForm

public interface DeedForm
extends OsidRelationshipForm

This is the form for creating and updating Deeds. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DeedAdminSession. 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
DeedFormRecord	getDeedFormRecord(Type deedRecordType) Gets the DeedFormRecord corresponding to the given deed 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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getDeedFormRecord

DeedFormRecord getDeedFormRecord(Type deedRecordType)
                                 throws OperationFailedException

Gets the DeedFormRecord corresponding to the given deed record Type.

Parameters:

deedRecordType - the deed record type

Returns:

the deed form record

Throws:

NullArgumentException - deedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedRecordType) is false

Compliance:

mandatory - This method must be implemented.