com.edustructures.sifworks.trans
Class EquipmentList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Equipment>
                  com.edustructures.sifworks.trans.EquipmentList

All Implemented Interfaces:

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

public class EquipmentList
extends SIFKeyedList<Equipment>

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

EquipmentList()
Constructor

EquipmentList(Equipment equipment)
Constructor that accepts values for all mandatory fields

Method Summary

void	addEquipment(java.lang.String busEquipmentRefId, java.lang.String count) Adds a new <Equipment> repeatable element.
Equipment	getEquipment(java.lang.String busEquipmentRefId) Gets an Equipment object instance.
Equipment[]	getEquipments() Gets all Equipment object instances.
void	removeEquipment(java.lang.String busEquipmentRefId) Removes an Equipment object instance.
void	setEquipments(Equipment[] equipments) Sets an array of Equipment objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

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

EquipmentList

public EquipmentList()

Constructor

EquipmentList

public EquipmentList(Equipment equipment)

Constructor that accepts values for all mandatory fields

Parameters:

equipment -

Method Detail

addEquipment

public void addEquipment(java.lang.String busEquipmentRefId,
                         java.lang.String count)

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

Parameters:

busEquipmentRefId - GUID that identifies the type of equipment

count - The number of pieces of this type of equipment

Since:

1.1

removeEquipment

public void removeEquipment(java.lang.String busEquipmentRefId)

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

Parameters:

busEquipmentRefId - Identifies the Equipment object to remove by its BusEquipmentRefId value

Since:

1.1

getEquipment

public Equipment getEquipment(java.lang.String busEquipmentRefId)

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

Parameters:

busEquipmentRefId - Identifies the Equipment object to return by its "BusEquipmentRefId" attribute value

Returns:

An Equipment object

Since:

1.1

getEquipments

public Equipment[] getEquipments()

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

Returns:

An array of Equipment objects

Since:

1.1

setEquipments

public void setEquipments(Equipment[] equipments)

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

Since:

1.1