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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getRoomsMetadata()
mandatory
- This method must be implemented. void setRooms(Id[] roomIds)
roomIds
- the new roomsInvalidArgumentException
- roomIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- roomIds
is
null
mandatory
- This method must be implemented. void clearRooms()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCostMetadata()
mandatory
- This method must be implemented. void setCost(Currency cost)
cost
- the new costInvalidArgumentException
- cost
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- cost
is
null
mandatory
- This method must be implemented. void clearCost()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. RenovationFormRecord getRenovationFormRecord(Type renovationRecordType) throws OperationFailedException
RenovationFormRecord
corresponding to the
given renovation record Type.
renovationRecordType
- the renovation record typeNullArgumentException
- renovationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(renovationRecordType)
is false
mandatory
- This method must be implemented.