com.edustructures.sifworks.student
Class DisciplineIncident

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.student.DisciplineIncident

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DisciplineIncident
extends SIFDataObject

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

DisciplineIncident()
Constructor

DisciplineIncident(java.lang.String refId, java.lang.Integer schoolYear, AgencyReporting agencyReporting, java.lang.String incidentNumber, java.util.Calendar incidentDate, IncidentTime incidentTime, IncidentLocation incidentLocation, IncidentCategory incidentCategory, OffenderList offenderList, VictimList victimList)
Constructor that accepts values for all mandatory fields

Method Summary

AgencyReporting	getAgencyReporting() Gets the value of the <AgencyReporting> element.
IncidentCategory	getIncidentCategory() Gets the value of the <IncidentCategory> element.
java.lang.String	getIncidentCost() Gets the value of the <IncidentCost> element.
java.util.Calendar	getIncidentDate() Gets the value of the <IncidentDate> element.
IncidentLocation	getIncidentLocation() Gets the value of the <IncidentLocation> element.
IncidentLocationRefId	getIncidentLocationRefId() Gets the value of the <IncidentLocationRefId> element.
java.lang.String	getIncidentNumber() Gets the value of the <IncidentNumber> element.
IncidentReporter	getIncidentReporter() Gets the value of the <IncidentReporter> element.
IncidentTime	getIncidentTime() Gets the value of the <IncidentTime> 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
OffenderList	getOffenderList() Gets the value of the <OffenderList> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
RelatedToList	getRelatedToList() Gets the value of the <RelatedToList> element.
java.lang.Integer	getSchoolYear() Gets the value of the SchoolYear attribute.
VictimList	getVictimList() Gets the value of the <VictimList> element.
WeaponTypeList	getWeaponTypeList() Gets the value of the <WeaponTypeList> element.
void	removeAgencyReporting() Removes the AgencyReporting child element previously created by calling setAgencyReporting
void	removeIncidentCategory() Removes the IncidentCategory child element previously created by calling setIncidentCategory
void	removeIncidentLocation() Removes the IncidentLocation child element previously created by calling setIncidentLocation
void	removeIncidentLocationRefId() Removes the IncidentLocationRefId child element previously created by calling setIncidentLocationRefId
void	removeIncidentReporter() Removes the IncidentReporter child element previously created by calling setIncidentReporter
void	removeIncidentTime() Removes the IncidentTime child element previously created by calling setIncidentTime
void	removeOffenderList() Removes the OffenderList child element previously created by calling setOffenderList
void	removeRelatedToList() Removes the RelatedToList child element previously created by calling setRelatedToList
void	removeVictimList() Removes the VictimList child element previously created by calling setVictimList
void	removeWeaponTypeList() Removes the WeaponTypeList child element previously created by calling setWeaponTypeList
void	setAgencyReporting(AgencyReporting value) Sets the value of the <AgencyReporting> element.
void	setAgencyReporting(AgencyReportingObject sifRefObject, java.lang.String value) Sets the value of the <AgencyReporting> child element.
void	setIncidentCategory(IncidentCategory value) Sets the value of the <IncidentCategory> element.
void	setIncidentCost(java.lang.String value) Sets the value of the <IncidentCost> element.
void	setIncidentDate(java.util.Calendar value) Sets the value of the <IncidentDate> element.
void	setIncidentLocation(IncidentLocation value) Sets the value of the <IncidentLocation> element.
void	setIncidentLocation(IncidentLocationType type, java.lang.String value) Sets the value of the <IncidentLocation> child element.
void	setIncidentLocationRefId(IncidentLocationObject sifRefObject, java.lang.String value) Sets the value of the <IncidentLocationRefId> child element.
void	setIncidentLocationRefId(IncidentLocationRefId value) Sets the value of the <IncidentLocationRefId> element.
void	setIncidentNumber(java.lang.String value) Sets the value of the <IncidentNumber> element.
void	setIncidentReporter(IncidentReporter value) Sets the value of the <IncidentReporter> element.
void	setIncidentReporter(ReporterDescriptionType type) Sets the value of the <IncidentReporter> child element.
void	setIncidentTime(IncidentTime value) Sets the value of the <IncidentTime> element.
void	setIncidentTime(SafetyTimeType type, java.lang.String value) Sets the value of the <IncidentTime> child element.
void	setOffenderList(OffenderList value) Sets the value of the <OffenderList> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setRelatedToList(RelatedToList value) Sets the value of the <RelatedToList> element.
void	setSchoolYear(java.lang.Integer value) Sets the value of the SchoolYear attribute.
void	setVictimList(VictimList value) Sets the value of the <VictimList> element.
void	setWeaponTypeList(WeaponTypeList value) Sets the value of the <WeaponTypeList> 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

DisciplineIncident

public DisciplineIncident()

Constructor

DisciplineIncident

public DisciplineIncident(java.lang.String refId,
                          java.lang.Integer schoolYear,
                          AgencyReporting agencyReporting,
                          java.lang.String incidentNumber,
                          java.util.Calendar incidentDate,
                          IncidentTime incidentTime,
                          IncidentLocation incidentLocation,
                          IncidentCategory incidentCategory,
                          OffenderList offenderList,
                          VictimList victimList)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The unique identifier (GUID) of this discipline incident.

schoolYear - School year in which the incident occurred, and for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year).

agencyReporting -

incidentNumber - The locally-defined unique identifier (within the school or school district) to identify this specific incident or occurrence.

incidentDate - The date when the incident occurred.

incidentTime - The time when the incident occurred.

incidentLocation - The locally-defined identifier or description of the location where the incident occurred.

incidentCategory -

offenderList -

victimList -

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: "The unique identifier (GUID) of this discipline incident."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

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: "The unique identifier (GUID) of this discipline incident."

Parameters:

value - A String object

Since:

2.0

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year in which the incident occurred, and for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year)."

Returns:

The SchoolYear attribute of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year in which the incident occurred, and for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007" for the 2006-07 school year)."

Parameters:

value - A Integer object

Since:

2.0

setAgencyReporting

public void setAgencyReporting(AgencyReporting value)

Sets the value of the <AgencyReporting> element.

Parameters:

value - A AgencyReporting object

Since:

2.0

setAgencyReporting

public void setAgencyReporting(AgencyReportingObject sifRefObject,
                               java.lang.String value)

Sets the value of the <AgencyReporting> child element. This form of setAgencyReporting is provided as a convenience method that is functionally equivalent to the version of setAgencyReporting that accepts a single AgencyReporting object.

Parameters:

sifRefObject - The name of the SIF object to which the GUID relates.

value - Gets or sets the content value of the <AgencyReporting> element

Since:

2.0

getAgencyReporting

public AgencyReporting getAgencyReporting()

Gets the value of the <AgencyReporting> element.

Returns:

An AgencyReporting object

Since:

2.0

removeAgencyReporting

public void removeAgencyReporting()

Removes the AgencyReporting child element previously created by calling setAgencyReporting

Since:

2.0

getIncidentNumber

public java.lang.String getIncidentNumber()

Gets the value of the <IncidentNumber> element.

The SIF specification defines the meaning of this element as: "The locally-defined unique identifier (within the school or school district) to identify this specific incident or occurrence."

Returns:

The IncidentNumber element of this object.

Since:

2.0

setIncidentNumber

public void setIncidentNumber(java.lang.String value)

Sets the value of the <IncidentNumber> element.

The SIF specification defines the meaning of this element as: "The locally-defined unique identifier (within the school or school district) to identify this specific incident or occurrence."

Parameters:

value - A String object

Since:

2.0

getIncidentDate

public java.util.Calendar getIncidentDate()

Gets the value of the <IncidentDate> element.

The SIF specification defines the meaning of this element as: "The date when the incident occurred."

Returns:

The IncidentDate element of this object.

Since:

2.0

setIncidentDate

public void setIncidentDate(java.util.Calendar value)

Sets the value of the <IncidentDate> element.

The SIF specification defines the meaning of this element as: "The date when the incident occurred."

Parameters:

value - A Calendar object

Since:

2.0

setIncidentTime

public void setIncidentTime(IncidentTime value)

Sets the value of the <IncidentTime> element.

The SIF specification defines the meaning of this element as: "The time when the incident occurred."

Parameters:

value - A IncidentTime object

Since:

2.0

setIncidentTime

public void setIncidentTime(SafetyTimeType type,
                            java.lang.String value)

Sets the value of the <IncidentTime> child element. This form of setIncidentTime is provided as a convenience method that is functionally equivalent to the version of setIncidentTime that accepts a single IncidentTime object.

Parameters:

type - Identifies whether or not the incident occurred during school hours.

value - Gets or sets the content value of the <IncidentTime> element

Since:

2.0

getIncidentTime

public IncidentTime getIncidentTime()

Gets the value of the <IncidentTime> element.

The SIF specification defines the meaning of this element as: "The time when the incident occurred."

Returns:

An IncidentTime object

Since:

2.0

removeIncidentTime

public void removeIncidentTime()

Removes the IncidentTime child element previously created by calling setIncidentTime

Since:

2.0

setIncidentLocation

public void setIncidentLocation(IncidentLocation value)

Sets the value of the <IncidentLocation> element.

The SIF specification defines the meaning of this element as: "The locally-defined identifier or description of the location where the incident occurred."

Parameters:

value - A IncidentLocation object

Since:

2.0

setIncidentLocation

public void setIncidentLocation(IncidentLocationType type,
                                java.lang.String value)

Sets the value of the <IncidentLocation> child element. This form of setIncidentLocation is provided as a convenience method that is functionally equivalent to the version of setIncidentLocation that accepts a single IncidentLocation object.

Parameters:

type - Identifies where the incident occurred.

value - Gets or sets the content value of the <IncidentLocation> element

Since:

2.0

getIncidentLocation

public IncidentLocation getIncidentLocation()

Gets the value of the <IncidentLocation> element.

The SIF specification defines the meaning of this element as: "The locally-defined identifier or description of the location where the incident occurred."

Returns:

An IncidentLocation object

Since:

2.0

removeIncidentLocation

public void removeIncidentLocation()

Removes the IncidentLocation child element previously created by calling setIncidentLocation

Since:

2.0

setIncidentLocationRefId

public void setIncidentLocationRefId(IncidentLocationRefId value)

Sets the value of the <IncidentLocationRefId> element.

Parameters:

value - A IncidentLocationRefId object

Since:

2.0

setIncidentLocationRefId

public void setIncidentLocationRefId(IncidentLocationObject sifRefObject,
                                     java.lang.String value)

Sets the value of the <IncidentLocationRefId> child element. This form of setIncidentLocationRefId is provided as a convenience method that is functionally equivalent to the version of setIncidentLocationRefId that accepts a single IncidentLocationRefId object.

Parameters:

sifRefObject - The name of the SIF object to which the GUID relates.

value - Gets or sets the content value of the <IncidentLocationRefId> element

Since:

2.0

getIncidentLocationRefId

public IncidentLocationRefId getIncidentLocationRefId()

Gets the value of the <IncidentLocationRefId> element.

Returns:

An IncidentLocationRefId object

Since:

2.0

removeIncidentLocationRefId

public void removeIncidentLocationRefId()

Removes the IncidentLocationRefId child element previously created by calling setIncidentLocationRefId

Since:

2.0

getIncidentCost

public java.lang.String getIncidentCost()

Gets the value of the <IncidentCost> element.

The SIF specification defines the meaning of this element as: "If the incident resulted in a quantifiable monetary loss for any entity involved, identify and record the value of that loss. Cost may be reported by specific dollar amount or range."

Returns:

The IncidentCost element of this object.

Since:

2.0

setIncidentCost

public void setIncidentCost(java.lang.String value)

Sets the value of the <IncidentCost> element.

The SIF specification defines the meaning of this element as: "If the incident resulted in a quantifiable monetary loss for any entity involved, identify and record the value of that loss. Cost may be reported by specific dollar amount or range."

Parameters:

value - A String object

Since:

2.0

setIncidentReporter

public void setIncidentReporter(IncidentReporter value)

Sets the value of the <IncidentReporter> element.

Parameters:

value - A IncidentReporter object

Since:

2.0

setIncidentReporter

public void setIncidentReporter(ReporterDescriptionType type)

Sets the value of the <IncidentReporter> child element. This form of setIncidentReporter is provided as a convenience method that is functionally equivalent to the version of setIncidentReporter that accepts a single IncidentReporter object.

Parameters:

type -

Since:

2.0

getIncidentReporter

public IncidentReporter getIncidentReporter()

Gets the value of the <IncidentReporter> element.

Returns:

An IncidentReporter object

Since:

2.0

removeIncidentReporter

public void removeIncidentReporter()

Removes the IncidentReporter child element previously created by calling setIncidentReporter

Since:

2.0

setRelatedToList

public void setRelatedToList(RelatedToList value)

Sets the value of the <RelatedToList> element.

Parameters:

value - A RelatedToList object

Since:

2.0

getRelatedToList

public RelatedToList getRelatedToList()

Gets the value of the <RelatedToList> element.

Returns:

A RelatedToList object

Since:

2.0

removeRelatedToList

public void removeRelatedToList()

Removes the RelatedToList child element previously created by calling setRelatedToList

Since:

2.0

setWeaponTypeList

public void setWeaponTypeList(WeaponTypeList value)

Sets the value of the <WeaponTypeList> element.

Parameters:

value - A WeaponTypeList object

Since:

2.0

getWeaponTypeList

public WeaponTypeList getWeaponTypeList()

Gets the value of the <WeaponTypeList> element.

Returns:

A WeaponTypeList object

Since:

2.0

removeWeaponTypeList

public void removeWeaponTypeList()

Removes the WeaponTypeList child element previously created by calling setWeaponTypeList

Since:

2.0

setIncidentCategory

public void setIncidentCategory(IncidentCategory value)

Sets the value of the <IncidentCategory> element.

Parameters:

value - A IncidentCategory object

Since:

2.0

getIncidentCategory

public IncidentCategory getIncidentCategory()

Gets the value of the <IncidentCategory> element.

Returns:

An IncidentCategory object

Since:

2.0

removeIncidentCategory

public void removeIncidentCategory()

Removes the IncidentCategory child element previously created by calling setIncidentCategory

Since:

2.0

setOffenderList

public void setOffenderList(OffenderList value)

Sets the value of the <OffenderList> element.

Parameters:

value - A OffenderList object

Since:

2.0

getOffenderList

public OffenderList getOffenderList()

Gets the value of the <OffenderList> element.

Returns:

An OffenderList object

Since:

2.0

removeOffenderList

public void removeOffenderList()

Removes the OffenderList child element previously created by calling setOffenderList

Since:

2.0

setVictimList

public void setVictimList(VictimList value)

Sets the value of the <VictimList> element.

Parameters:

value - A VictimList object

Since:

2.0

getVictimList

public VictimList getVictimList()

Gets the value of the <VictimList> element.

Returns:

A VictimList object

Since:

2.0

removeVictimList

public void removeVictimList()

Removes the VictimList child element previously created by calling setVictimList

Since:

2.0