org.osid.room.squatting

Interface LeaseForm

All Superinterfaces:

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

All Known Subinterfaces:

LeaseBatchForm

public interface LeaseForm
extends OsidRelationshipForm

This is the form for creating and updating Leases. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the LeaseAdminSession. 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
LeaseFormRecord	getLeaseFormRecord(Type leaseRecordType) Gets the LeaseFormRecord corresponding to the given lease 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

getLeaseFormRecord

LeaseFormRecord getLeaseFormRecord(Type leaseRecordType)
                                   throws OperationFailedException

Gets the LeaseFormRecord corresponding to the given lease record Type.

Parameters:

leaseRecordType - the lease record type

Returns:

the lease form record

Throws:

NullArgumentException - leaseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseRecordType) is false

Compliance:

mandatory - This method must be implemented.