com.edustructures.sifworks.trans
Class TransferPoint

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

public class TransferPoint
extends SIFElement

Describes a transfer point for each intermediate point on a trip

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
TransferPoint()
          Constructor
TransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail, DisembarkBusRouteDetail disembarkBusRouteDetail)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 DisembarkBusRouteDetail getDisembarkBusRouteDetail()
          Gets the value of the <DisembarkBusRouteDetail> element.
 EmbarkBusRouteDetail getEmbarkBusRouteDetail()
          Gets the value of the <EmbarkBusRouteDetail> 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
 void removeDisembarkBusRouteDetail()
          Removes the DisembarkBusRouteDetail child element previously created by calling setDisembarkBusRouteDetail
 void removeEmbarkBusRouteDetail()
          Removes the EmbarkBusRouteDetail child element previously created by calling setEmbarkBusRouteDetail
 void setDisembarkBusRouteDetail(DisembarkBusRouteDetail value)
          Sets the value of the <DisembarkBusRouteDetail> element.
 void setDisembarkBusRouteDetail(java.lang.String sifRefObject, java.lang.String value)
          Sets the value of the <DisembarkBusRouteDetail> child element.
 void setEmbarkBusRouteDetail(EmbarkBusRouteDetail value)
          Sets the value of the <EmbarkBusRouteDetail> element.
 void setEmbarkBusRouteDetail(java.lang.String sifRefObject, java.lang.String value)
          Sets the value of the <EmbarkBusRouteDetail> child element.
 
Methods inherited from class com.edustructures.sifworks.SIFElement
addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

TransferPoint

public TransferPoint()
Constructor


TransferPoint

public TransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail,
                     DisembarkBusRouteDetail disembarkBusRouteDetail)
Constructor that accepts values for all mandatory fields

Parameters:
embarkBusRouteDetail - The GUID that identifies the bus stop/route when the student gets on the bus.
disembarkBusRouteDetail - The GUID that identifies the bus stop/route when the student gets off 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

setEmbarkBusRouteDetail

public void setEmbarkBusRouteDetail(EmbarkBusRouteDetail value)
Sets the value of the <EmbarkBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "The GUID that identifies the bus stop/route when the student gets on the bus."

Parameters:
value - A EmbarkBusRouteDetail object
Since:
1.1

setEmbarkBusRouteDetail

public void setEmbarkBusRouteDetail(java.lang.String sifRefObject,
                                    java.lang.String value)
Sets the value of the <EmbarkBusRouteDetail> child element. This form of setEmbarkBusRouteDetail is provided as a convenience method that is functionally equivalent to the version of setEmbarkBusRouteDetail that accepts a single EmbarkBusRouteDetail object.

Parameters:
sifRefObject -
value - Gets or sets the content value of the <EmbarkBusRouteDetail> element
Since:
1.1

getEmbarkBusRouteDetail

public EmbarkBusRouteDetail getEmbarkBusRouteDetail()
Gets the value of the <EmbarkBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "The GUID that identifies the bus stop/route when the student gets on the bus."

Returns:
An EmbarkBusRouteDetail object
Since:
1.1

removeEmbarkBusRouteDetail

public void removeEmbarkBusRouteDetail()
Removes the EmbarkBusRouteDetail child element previously created by calling setEmbarkBusRouteDetail

Since:
1.1

setDisembarkBusRouteDetail

public void setDisembarkBusRouteDetail(DisembarkBusRouteDetail value)
Sets the value of the <DisembarkBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "The GUID that identifies the bus stop/route when the student gets off the bus."

Parameters:
value - A DisembarkBusRouteDetail object
Since:
1.1

setDisembarkBusRouteDetail

public void setDisembarkBusRouteDetail(java.lang.String sifRefObject,
                                       java.lang.String value)
Sets the value of the <DisembarkBusRouteDetail> child element. This form of setDisembarkBusRouteDetail is provided as a convenience method that is functionally equivalent to the version of setDisembarkBusRouteDetail that accepts a single DisembarkBusRouteDetail object.

Parameters:
sifRefObject -
value - Gets or sets the content value of the <DisembarkBusRouteDetail> element
Since:
1.1

getDisembarkBusRouteDetail

public DisembarkBusRouteDetail getDisembarkBusRouteDetail()
Gets the value of the <DisembarkBusRouteDetail> element.

The SIF specification defines the meaning of this element as: "The GUID that identifies the bus stop/route when the student gets off the bus."

Returns:
A DisembarkBusRouteDetail object
Since:
1.1

removeDisembarkBusRouteDetail

public void removeDisembarkBusRouteDetail()
Removes the DisembarkBusRouteDetail child element previously created by calling setDisembarkBusRouteDetail

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.