org.osid.room.construction

Interface RenovationForm

All Superinterfaces:

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

All Known Subinterfaces:

RenovationBatchForm

public interface RenovationForm
extends OsidObjectForm, OsidTemporalForm

This is the form for creating and updating Renovations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RenovationAdminSession. 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
void	clearCost() Clears the cost.
void	clearRooms() Clears the rooms.
Metadata	getCostMetadata() Gets the metadata for the cost.
RenovationFormRecord	getRenovationFormRecord(Type renovationRecordType) Gets the RenovationFormRecord corresponding to the given renovation record Type.
Metadata	getRoomsMetadata() Gets the metadata for a set of rooms.
void	setCost(Currency cost) Sets the cost.
void	setRooms(Id[] roomIds) Sets the rooms.

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

getRoomsMetadata

Metadata getRoomsMetadata()

Gets the metadata for a set of rooms.

Returns:

metadata for the rooms

Compliance:

mandatory - This method must be implemented.

setRooms

void setRooms(Id[] roomIds)

Sets the rooms.

Parameters:

roomIds - the new rooms

Throws:

InvalidArgumentException - roomIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - roomIds is null

Compliance:

mandatory - This method must be implemented.

clearRooms

void clearRooms()

Clears the rooms.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCostMetadata

Metadata getCostMetadata()

Gets the metadata for the cost.

Returns:

metadata for the cost

Compliance:

mandatory - This method must be implemented.

setCost

void setCost(Currency cost)

Sets the cost.

Parameters:

cost - the new cost

Throws:

InvalidArgumentException - cost is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - cost is null

Compliance:

mandatory - This method must be implemented.

clearCost

void clearCost()

Clears the cost.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRenovationFormRecord

RenovationFormRecord getRenovationFormRecord(Type renovationRecordType)
                                             throws OperationFailedException

Gets the RenovationFormRecord corresponding to the given renovation record Type.

Parameters:

renovationRecordType - the renovation record type

Returns:

the renovation form record

Throws:

NullArgumentException - renovationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(renovationRecordType) is false

Compliance:

mandatory - This method must be implemented.