com.edustructures.sifworks.student
Class RoomInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.student.RoomInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RoomInfo
extends SIFDataObject

This object contains all of the information about a school's room. This object contains a reference to a room type so that it may represent anything from a gym, cafeteria, to a standard classroom.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

RoomInfo()
Constructor

RoomInfo(java.lang.String refId, java.lang.String schoolInfoRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getBuilding() Gets the value of the <Building> element.
java.lang.Integer	getCapacity() Gets the value of the <Capacity> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getHomeroomNumber() Gets the value of the <HomeroomNumber> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
PhoneNumber	getPhoneNumber() Gets the value of the <PhoneNumber> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getRoomNumber() Gets the value of the <RoomNumber> element.
java.lang.String	getRoomTypeRefId() Gets the value of the <RoomTypeRefId> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.Integer	getSize() Gets the value of the <Size> element.
StaffList	getStaffList() Gets the value of the <StaffList> element.
void	removePhoneNumber() Removes the PhoneNumber child element previously created by calling setPhoneNumber
void	removeStaffList() Removes the StaffList child element previously created by calling setStaffList
void	setBuilding(java.lang.String value) Sets the value of the <Building> element.
void	setCapacity(java.lang.Integer value) Sets the value of the <Capacity> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setHomeroomNumber(java.lang.String value) Sets the value of the <HomeroomNumber> element.
void	setPhoneNumber(PhoneNumber value) Sets the value of the <PhoneNumber> element.
void	setPhoneNumber(PhoneNumberType type, java.lang.String number) Sets the value of the <PhoneNumber> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setRoomNumber(java.lang.String value) Sets the value of the <RoomNumber> element.
void	setRoomTypeRefId(java.lang.String value) Sets the value of the <RoomTypeRefId> element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the SchoolInfoRefId attribute.
void	setSize(java.lang.Integer value) Sets the value of the <Size> element.
void	setStaffList(StaffList value) Sets the value of the <StaffList> element.
void	setStaffList(StaffPersonalRefId staffPersonalRefId) Sets the value of the <StaffList> child element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoomInfo

public RoomInfo()

Constructor

RoomInfo

public RoomInfo(java.lang.String refId,
                java.lang.String schoolInfoRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies this room.

schoolInfoRefId - GUID that identifies the school that this room belongs to.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this room."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies this room."

Parameters:

value - A String object

Since:

1.1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the school that this room belongs to."

Returns:

The SchoolInfoRefId attribute of this object.

Since:

1.1

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the school that this room belongs to."

Parameters:

value - A String object

Since:

1.1

getRoomNumber

public java.lang.String getRoomNumber()

Gets the value of the <RoomNumber> element.

The SIF specification defines the meaning of this element as: "Room number as presented to the user/application."

Returns:

The RoomNumber element of this object.

Since:

1.1

setRoomNumber

public void setRoomNumber(java.lang.String value)

Sets the value of the <RoomNumber> element.

The SIF specification defines the meaning of this element as: "Room number as presented to the user/application."

Parameters:

value - A String object

Since:

1.1

setStaffList

public void setStaffList(StaffList value)

Sets the value of the <StaffList> element.

The SIF specification defines the meaning of this element as: "Staff assigned to this room. For example, the homeroom teacher."

Parameters:

value - A StaffList object

Since:

1.1

setStaffList

public void setStaffList(StaffPersonalRefId staffPersonalRefId)

Sets the value of the <StaffList> child element. This form of setStaffList is provided as a convenience method that is functionally equivalent to the version of setStaffList that accepts a single StaffList object.

Parameters:

staffPersonalRefId - Staff assigned to this room. For example, the homeroom teacher.

Since:

1.1

getStaffList

public StaffList getStaffList()

Gets the value of the <StaffList> element.

The SIF specification defines the meaning of this element as: "Staff assigned to this room. For example, the homeroom teacher."

Returns:

A StaffList object

Since:

1.1

removeStaffList

public void removeStaffList()

Removes the StaffList child element previously created by calling setStaffList

Since:

1.1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Friendly name that can be assigned to the room (e.g. Staff Cafeteria)."

Returns:

The Description element of this object.

Since:

1.1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Friendly name that can be assigned to the room (e.g. Staff Cafeteria)."

Parameters:

value - A String object

Since:

1.1

getBuilding

public java.lang.String getBuilding()

Gets the value of the <Building> element.

The SIF specification defines the meaning of this element as: "Extra building information. In the future Building could become its own object in which case this element will need to be changed to a RefId. Currently it is only required as a free text field."

Returns:

The Building element of this object.

Since:

1.1

setBuilding

public void setBuilding(java.lang.String value)

Sets the value of the <Building> element.

The SIF specification defines the meaning of this element as: "Extra building information. In the future Building could become its own object in which case this element will need to be changed to a RefId. Currently it is only required as a free text field."

Parameters:

value - A String object

Since:

1.1

getHomeroomNumber

public java.lang.String getHomeroomNumber()

Gets the value of the <HomeroomNumber> element.

The SIF specification defines the meaning of this element as: "When a room is designated as a homeroom it may have a different number. Usually blank when room is not a homeroom."

Returns:

The HomeroomNumber element of this object.

Since:

1.1

setHomeroomNumber

public void setHomeroomNumber(java.lang.String value)

Sets the value of the <HomeroomNumber> element.

The SIF specification defines the meaning of this element as: "When a room is designated as a homeroom it may have a different number. Usually blank when room is not a homeroom."

Parameters:

value - A String object

Since:

1.1

getSize

public java.lang.Integer getSize()

Gets the value of the <Size> element.

The SIF specification defines the meaning of this element as: "Size in square feet."

Returns:

The Size element of this object.

Since:

1.1

setSize

public void setSize(java.lang.Integer value)

Sets the value of the <Size> element.

The SIF specification defines the meaning of this element as: "Size in square feet."

Parameters:

value - A Integer object

Since:

1.1

getCapacity

public java.lang.Integer getCapacity()

Gets the value of the <Capacity> element.

The SIF specification defines the meaning of this element as: "Number of persons (usually students) that this room can hold."

Returns:

The Capacity element of this object.

Since:

1.1

setCapacity

public void setCapacity(java.lang.Integer value)

Sets the value of the <Capacity> element.

The SIF specification defines the meaning of this element as: "Number of persons (usually students) that this room can hold."

Parameters:

value - A Integer object

Since:

1.1

setPhoneNumber

public void setPhoneNumber(PhoneNumber value)

Sets the value of the <PhoneNumber> element.

The SIF specification defines the meaning of this element as: "Phone number for the room"

Parameters:

value - A PhoneNumber object

Since:

1.1

setPhoneNumber

public void setPhoneNumber(PhoneNumberType type,
                           java.lang.String number)

Sets the value of the <PhoneNumber> child element. This form of setPhoneNumber is provided as a convenience method that is functionally equivalent to the version of setPhoneNumber that accepts a single PhoneNumber object.

Parameters:

type - Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.

number - Phone number. Acceptable formats:

Since:

1.1

getPhoneNumber

public PhoneNumber getPhoneNumber()

Gets the value of the <PhoneNumber> element.

The SIF specification defines the meaning of this element as: "Phone number for the room"

Returns:

A PhoneNumber object

Since:

1.1

removePhoneNumber

public void removePhoneNumber()

Removes the PhoneNumber child element previously created by calling setPhoneNumber

Since:

1.1

getRoomTypeRefId

public java.lang.String getRoomTypeRefId()

Gets the value of the <RoomTypeRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the room type assigned to this room."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"TypeOfRoom"
SIF2.0	"RoomTypeRefId"

Returns:

The RoomTypeRefId element of this object.

Since:

1.1

setRoomTypeRefId

public void setRoomTypeRefId(java.lang.String value)

Sets the value of the <RoomTypeRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the room type assigned to this room."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"TypeOfRoom"
SIF2.0	"RoomTypeRefId"

Parameters:

value - A String object

Since:

1.1