com.edustructures.sifworks.student
Class OffenderList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Offender>
                  com.edustructures.sifworks.student.OffenderList

All Implemented Interfaces:

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

public class OffenderList
extends SIFKeyedList<Offender>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

OffenderList()
Constructor

OffenderList(Offender offender)
Constructor that accepts values for all mandatory fields

Method Summary

void	addOffender(ReporterDescriptionType type, InjuryType injury) Adds a new <Offender> repeatable element.
Offender	getOffender(ReporterDescriptionType type) Gets an Offender object instance.
Offender[]	getOffenders() Gets all Offender object instances.
void	removeOffender(ReporterDescriptionType type) Removes an Offender object instance.
void	setOffenders(Offender[] offenders) Sets an array of Offender 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

OffenderList

public OffenderList()

Constructor

OffenderList

public OffenderList(Offender offender)

Constructor that accepts values for all mandatory fields

Parameters:

offender -

Method Detail

addOffender

public void addOffender(ReporterDescriptionType type,
                        InjuryType injury)

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

Parameters:

type - Identifies the type of offender involved in the incident.

injury - Identifies whether or not this specific offender was physically injured, and if so, identifies whether the injury was major or minor.

Since:

2.0

removeOffender

public void removeOffender(ReporterDescriptionType type)

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

Parameters:

type - Identifies the Offender object to remove by its Type value

Since:

2.0

getOffender

public Offender getOffender(ReporterDescriptionType type)

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

Parameters:

type - Identifies the Offender object to return by its "Type" attribute value

Returns:

An Offender object

Since:

2.0

getOffenders

public Offender[] getOffenders()

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

Returns:

An array of Offender objects

Since:

2.0

setOffenders

public void setOffenders(Offender[] offenders)

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

Since:

2.0