Interface RoomForm

All Superinterfaces:

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

All Known Subinterfaces:

RoomBatchForm

public interface RoomForm
extends OsidObjectForm, OsidTemporalForm, OsidSubjugateableForm

This is the form for creating and updating Rooms. Like all OsidForms, various data elements may be set here for use in the create and update methods in the RoomAdminSession. 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	clearArea()	Clears the area.
void	clearCode()	Clears the room code.
void	clearDesignatedName()	Clears the designated name.
void	clearEnclosingRoom()	Clears the enclosing room.
void	clearOccupancyLimit()	Clears the occupancy limit.
void	clearResources()	Clears the resources.
Metadata	getAreaMetadata()	Gets the metadata for the area.
Metadata	getCodeMetadata()	Gets the metadata for a code.
Metadata	getDesignatedNameMetadata()	Gets the metadata for a designated name.
Metadata	getEnclosingRoomMetadata()	Gets the metadata for an enclosing room.
Metadata	getOccupancyLimitMetadata()	Gets the metadata for the room occupancy limit.
Metadata	getResourcesMetadata()	Gets the metadata for the room resources.
RoomFormRecord	getRoomFormRecord(Type roomRecordType)	Gets the RoomFormRecord corresponding to the given room record Type.
void	setArea(BigDecimal area)	Sets the area.
void	setCode(String code)	Sets the room code.
void	setDesignatedName(String name)	Sets the designated name.
void	setEnclosingRoom(Id roomId)	Sets the enclosing room.
void	setOccupancyLimit(long linit)	Sets the occupancy limit of the room.
void	setResources(IdList resourceIds)	Sets the resources.

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

getEnclosingRoomMetadata

Metadata getEnclosingRoomMetadata()

Gets the metadata for an enclosing room.

Returns:

metadata for the enclosing room

Compliance:

mandatory - This method must be implemented.

setEnclosingRoom

void setEnclosingRoom(Id roomId)

Sets the enclosing room.

Parameters:

roomId - the new enclosing room

Throws:

InvalidArgumentException - roomId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - roomId is null

Compliance:

mandatory - This method must be implemented.

clearEnclosingRoom

void clearEnclosingRoom()

Clears the enclosing room.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDesignatedNameMetadata

Metadata getDesignatedNameMetadata()

Gets the metadata for a designated name.

Returns:

metadata for the designated name

Compliance:

mandatory - This method must be implemented.

setDesignatedName

void setDesignatedName(String name)

Sets the designated name.

Parameters:

name - the new name

Throws:

InvalidArgumentException - name is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - name is null

Compliance:

mandatory - This method must be implemented.

clearDesignatedName

void clearDesignatedName()

Clears the designated name.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCodeMetadata

Metadata getCodeMetadata()

Gets the metadata for a code.

Returns:

metadata for the code

Compliance:

mandatory - This method must be implemented.

setCode

void setCode(String code)

Sets the room code.

Parameters:

code - the new code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - code is null

Compliance:

mandatory - This method must be implemented.

clearCode

void clearCode()

Clears the room code.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAreaMetadata

Metadata getAreaMetadata()

Gets the metadata for the area.

Returns:

metadata for the area

Compliance:

mandatory - This method must be implemented.

setArea

void setArea(BigDecimal area)

Sets the area.

Parameters:

area - the new area

Throws:

InvalidArgumentException - area is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - area is null

Compliance:

mandatory - This method must be implemented.

clearArea

void clearArea()

Clears the area.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getOccupancyLimitMetadata

Metadata getOccupancyLimitMetadata()

Gets the metadata for the room occupancy limit.

Returns:

metadata for the area

Compliance:

mandatory - This method must be implemented.

setOccupancyLimit

void setOccupancyLimit(long linit)

Sets the occupancy limit of the room.

Parameters:

linit - the new linit

Throws:

InvalidArgumentException - limit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearOccupancyLimit

void clearOccupancyLimit()

Clears the occupancy limit.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getResourcesMetadata

Metadata getResourcesMetadata()

Gets the metadata for the room resources.

Returns:

metadata for the resources

Compliance:

mandatory - This method must be implemented.

setResources

void setResources(IdList resourceIds)

Sets the resources.

Parameters:

resourceIds - the new resources

Throws:

InvalidArgumentException - resourceIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

clearResources

void clearResources()

Clears the resources.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRoomFormRecord

RoomFormRecord getRoomFormRecord(Type roomRecordType)
                          throws OperationFailedException

Gets the RoomFormRecord corresponding to the given room record Type.

Parameters:

roomRecordType - the room record type

Returns:

the room form record

Throws:

NullArgumentException - roomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomRecordType) is false

Compliance:

mandatory - This method must be implemented.