com.edustructures.sifworks.trans
Class TransferPoints

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<TransferPoint>
              com.edustructures.sifworks.trans.TransferPoints

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<TransferPoint>, java.util.Collection<TransferPoint>

public class TransferPoints
extends SIFList<TransferPoint>

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

TransferPoints()
Constructor

TransferPoints(TransferPoint transferPoint)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail, DisembarkBusRouteDetail disembarkBusRouteDetail) Adds a new <TransferPoint> repeatable element.
TransferPoint	getTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail, DisembarkBusRouteDetail disembarkBusRouteDetail) Gets a TransferPoint object instance.
TransferPoint[]	getTransferPoints() Gets all TransferPoint object instances.
void	removeTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail, DisembarkBusRouteDetail disembarkBusRouteDetail) Removes a TransferPoint object instance.
void	setTransferPoints(TransferPoint[] transferpoints) Sets an array of TransferPoint objects.

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

TransferPoints

public TransferPoints()

Constructor

TransferPoints

public TransferPoints(TransferPoint transferPoint)

Constructor that accepts values for all mandatory fields

Parameters:

transferPoint - There should be one TransferPoint for each intermediate point on a trip. The "embark" and "disembark" bus stops for a single transfer point must be at the same location. To order multiple TransferPoint elements, use the Time element of the BusStopInfo objects referenced by the attributes.

Method Detail

addTransferPoint

public void addTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail,
                             DisembarkBusRouteDetail disembarkBusRouteDetail)

Adds a new <TransferPoint> repeatable element. This form of setTransferPoint is provided as a convenience method that is functionally equivalent to the version of setTransferPoint that accepts a single TransferPoint object.

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.

Since:

1.1

removeTransferPoint

public void removeTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail,
                                DisembarkBusRouteDetail disembarkBusRouteDetail)

Removes a TransferPoint object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

embarkBusRouteDetail - Identifies the TransferPoint object to remove by its EmbarkBusRouteDetail value

disembarkBusRouteDetail - Identifies the TransferPoint object to remove by its DisembarkBusRouteDetail value

Since:

1.1

getTransferPoint

public TransferPoint getTransferPoint(EmbarkBusRouteDetail embarkBusRouteDetail,
                                      DisembarkBusRouteDetail disembarkBusRouteDetail)

Gets a TransferPoint object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

embarkBusRouteDetail - Identifies the TransferPoint object to return by its "EmbarkBusRouteDetail" attribute value

disembarkBusRouteDetail - Identifies the TransferPoint object to return by its "DisembarkBusRouteDetail" attribute value

Returns:

A TransferPoint object

Since:

1.1

getTransferPoints

public TransferPoint[] getTransferPoints()

Gets all TransferPoint object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of TransferPoint objects

Since:

1.1

setTransferPoints

public void setTransferPoints(TransferPoint[] transferpoints)

Sets an array of TransferPoint objects. All existing TransferPoint instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all TransferPoints.

Since:

1.1