com.edustructures.sifworks.trans
Class BusInfo

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFDataObject
              extended by com.edustructures.sifworks.trans.BusInfo
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class BusInfo
extends SIFDataObject

This object contains all of the information about a bus.

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
BusInfo()
          Constructor
BusInfo(java.lang.String refId, java.lang.String vehicleNumber)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.String getContractor()
          Gets the value of the <Contractor> element.
 EquipmentList getEquipmentList()
          Gets the value of the <EquipmentList> 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
 java.lang.String getRefId()
          Gets the value of the RefId attribute.
 java.lang.Integer getSeatingCapacity()
          Gets the value of the <SeatingCapacity> element.
 java.lang.String getVehicleNumber()
          Gets the value of the <VehicleNumber> element.
 void removeEquipmentList()
          Removes the EquipmentList child element previously created by calling setEquipmentList
 void setContractor(java.lang.String value)
          Sets the value of the <Contractor> element.
 void setEquipmentList(EquipmentList value)
          Sets the value of the <EquipmentList> element.
 void setRefId(java.lang.String value)
          Sets the value of the RefId attribute.
 void setSeatingCapacity(java.lang.Integer value)
          Sets the value of the <SeatingCapacity> element.
 void setVehicleNumber(java.lang.String value)
          Sets the value of the <VehicleNumber> 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

BusInfo

public BusInfo()
Constructor


BusInfo

public BusInfo(java.lang.String refId,
               java.lang.String vehicleNumber)
Constructor that accepts values for all mandatory fields

Parameters:
refId - GUID that identifies this bus.
vehicleNumber - Vehicle number of the bus.
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 bus."

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 bus."

Parameters:
value - A String object
Since:
1.1

getVehicleNumber

public java.lang.String getVehicleNumber()
Gets the value of the <VehicleNumber> element.

The SIF specification defines the meaning of this element as: "Vehicle number of the bus."

Returns:
The VehicleNumber element of this object.
Since:
1.1

setVehicleNumber

public void setVehicleNumber(java.lang.String value)
Sets the value of the <VehicleNumber> element.

The SIF specification defines the meaning of this element as: "Vehicle number of the bus."

Parameters:
value - A String object
Since:
1.1

getSeatingCapacity

public java.lang.Integer getSeatingCapacity()
Gets the value of the <SeatingCapacity> element.

The SIF specification defines the meaning of this element as: "The number of people who can ride on the bus at the same time."

Returns:
The SeatingCapacity element of this object.
Since:
1.1

setSeatingCapacity

public void setSeatingCapacity(java.lang.Integer value)
Sets the value of the <SeatingCapacity> element.

The SIF specification defines the meaning of this element as: "The number of people who can ride on the bus at the same time."

Parameters:
value - A Integer object
Since:
1.1

getContractor

public java.lang.String getContractor()
Gets the value of the <Contractor> element.

The SIF specification defines the meaning of this element as: "The name of the contractor for this bus."

Returns:
The Contractor element of this object.
Since:
1.1

setContractor

public void setContractor(java.lang.String value)
Sets the value of the <Contractor> element.

The SIF specification defines the meaning of this element as: "The name of the contractor for this bus."

Parameters:
value - A String object
Since:
1.1

setEquipmentList

public void setEquipmentList(EquipmentList value)
Sets the value of the <EquipmentList> element.

The SIF specification defines the meaning of this element as: "Describes any special equipment that is on this bus"

Parameters:
value - A EquipmentList object
Since:
1.1

getEquipmentList

public EquipmentList getEquipmentList()
Gets the value of the <EquipmentList> element.

The SIF specification defines the meaning of this element as: "Describes any special equipment that is on this bus"

Returns:
An EquipmentList object
Since:
1.1

removeEquipmentList

public void removeEquipmentList()
Removes the EquipmentList child element previously created by calling setEquipmentList

Since:
1.1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.