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 OsidForms , 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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

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.