com.edustructures.sifworks.student
Class Action

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.student.Action

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Action
extends SIFElement

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

Action()
Constructor

Action(java.lang.String code, java.util.Calendar startDate, java.util.Calendar endDate, java.math.BigDecimal duration, YesNo zeroTolerance, YesNo fullYearExpulsion, YesNo shortenedExpulsion, YesNo policeNotification, ArrestStatus arrest, YesNo alternativeEducation)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getAlternativeEducation() Gets the value of the <AlternativeEducation> element.
java.lang.String	getArrest() Gets the value of the <Arrest> element.
java.lang.String	getCode() Gets the value of the <Code> element.
java.math.BigDecimal	getDuration() Gets the value of the <Duration> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
java.lang.String	getFullYearExpulsion() Gets the value of the <FullYearExpulsion> element.
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
java.lang.String	getPoliceNotification() Gets the value of the <PoliceNotification> element.
java.lang.String	getShortenedExpulsion() Gets the value of the <ShortenedExpulsion> element.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
java.lang.String	getZeroTolerance() Gets the value of the <ZeroTolerance> element.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setAlternativeEducation(java.lang.String value) Sets the value of the <AlternativeEducation> element as a String.
void	setAlternativeEducation(YesNo value) Sets the value of the <AlternativeEducation> element.
void	setArrest(ArrestStatus value) Sets the value of the <Arrest> element.
void	setArrest(java.lang.String value) Sets the value of the <Arrest> element as a String.
void	setCode(java.lang.String value) Sets the value of the <Code> element.
void	setDuration(java.math.BigDecimal value) Sets the value of the <Duration> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setFullYearExpulsion(java.lang.String value) Sets the value of the <FullYearExpulsion> element as a String.
void	setFullYearExpulsion(YesNo value) Sets the value of the <FullYearExpulsion> element.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> element.
void	setPoliceNotification(java.lang.String value) Sets the value of the <PoliceNotification> element as a String.
void	setPoliceNotification(YesNo value) Sets the value of the <PoliceNotification> element.
void	setShortenedExpulsion(java.lang.String value) Sets the value of the <ShortenedExpulsion> element as a String.
void	setShortenedExpulsion(YesNo value) Sets the value of the <ShortenedExpulsion> element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> element.
void	setZeroTolerance(java.lang.String value) Sets the value of the <ZeroTolerance> element as a String.
void	setZeroTolerance(YesNo value) Sets the value of the <ZeroTolerance> 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, 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

Constructor Detail

Action

public Action()

Constructor

Action

public Action(java.lang.String code,
              java.util.Calendar startDate,
              java.util.Calendar endDate,
              java.math.BigDecimal duration,
              YesNo zeroTolerance,
              YesNo fullYearExpulsion,
              YesNo shortenedExpulsion,
              YesNo policeNotification,
              ArrestStatus arrest,
              YesNo alternativeEducation)

Constructor that accepts values for all mandatory fields

Parameters:

code -

startDate - The date on which the disciplinary action begins.

endDate - The date through which the disciplinary action is in effect, inclusive.

duration - Identifies the length, in school days, of the disciplinary action. Note: decimal places may be used for fractions of school days.

zeroTolerance - Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies.

fullYearExpulsion - Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days).

shortenedExpulsion - Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district.

policeNotification - Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken.

arrest - Identifies whether or not the offender was arrested.

alternativeEducation - Identifies whether or not the offender was assigned to an Alternative Education facility.

Method Detail

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

Returns:

The Code element of this object.

Since:

2.0

setCode

public void setCode(java.lang.String value)

Sets the value of the <Code> element.

Parameters:

value - A String object

Since:

2.0

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

The SIF specification defines the meaning of this element as: "List of other codes or strings that crosswalk to or serve as translations of the Code element. If Code changes and OtherCode elements are supported, both Code and all associated OtherCode elements must be present."

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

The SIF specification defines the meaning of this element as: "List of other codes or strings that crosswalk to or serve as translations of the Code element. If Code changes and OtherCode elements are supported, both Code and all associated OtherCode elements must be present."

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "The date on which the disciplinary action begins."

Returns:

The StartDate element of this object.

Since:

2.0

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "The date on which the disciplinary action begins."

Parameters:

value - A Calendar object

Since:

2.0

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "The date through which the disciplinary action is in effect, inclusive."

Returns:

The EndDate element of this object.

Since:

2.0

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "The date through which the disciplinary action is in effect, inclusive."

Parameters:

value - A Calendar object

Since:

2.0

getDuration

public java.math.BigDecimal getDuration()

Gets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Identifies the length, in school days, of the disciplinary action. Note: decimal places may be used for fractions of school days."

Returns:

The Duration element of this object.

Since:

2.0

setDuration

public void setDuration(java.math.BigDecimal value)

Sets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Identifies the length, in school days, of the disciplinary action. Note: decimal places may be used for fractions of school days."

Parameters:

value - A BigDecimal object

Since:

2.0

getZeroTolerance

public java.lang.String getZeroTolerance()

Gets the value of the <ZeroTolerance> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies."

Returns:

The ZeroTolerance element of this object.

Since:

2.0

setZeroTolerance

public void setZeroTolerance(YesNo value)

Sets the value of the <ZeroTolerance> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setZeroTolerance

public void setZeroTolerance(java.lang.String value)

Sets the value of the <ZeroTolerance> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not this action taken against a student was imposed as a consequence of state or local zero tolerance policies."

Parameters:

value - The value as a String

Since:

2.0

getFullYearExpulsion

public java.lang.String getFullYearExpulsion()

Gets the value of the <FullYearExpulsion> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days)."

Returns:

The FullYearExpulsion element of this object.

Since:

2.0

setFullYearExpulsion

public void setFullYearExpulsion(YesNo value)

Sets the value of the <FullYearExpulsion> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days)."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setFullYearExpulsion

public void setFullYearExpulsion(java.lang.String value)

Sets the value of the <FullYearExpulsion> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services for a period of one full year (i.e., 365 days)."

Parameters:

value - The value as a String

Since:

2.0

getShortenedExpulsion

public java.lang.String getShortenedExpulsion()

Gets the value of the <ShortenedExpulsion> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district."

Returns:

The ShortenedExpulsion element of this object.

Since:

2.0

setShortenedExpulsion

public void setShortenedExpulsion(YesNo value)

Sets the value of the <ShortenedExpulsion> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setShortenedExpulsion

public void setShortenedExpulsion(java.lang.String value)

Sets the value of the <ShortenedExpulsion> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not the action involved an expulsion with or without services that is shortened to a term of less than one year by the superintendent or chief administrator of a school district."

Parameters:

value - The value as a String

Since:

2.0

getPoliceNotification

public java.lang.String getPoliceNotification()

Gets the value of the <PoliceNotification> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken."

Returns:

The PoliceNotification element of this object.

Since:

2.0

setPoliceNotification

public void setPoliceNotification(YesNo value)

Sets the value of the <PoliceNotification> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setPoliceNotification

public void setPoliceNotification(java.lang.String value)

Sets the value of the <PoliceNotification> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender's action included notification of local law enforcement, regardless of whether official action was taken."

Parameters:

value - The value as a String

Since:

2.0

getArrest

public java.lang.String getArrest()

Gets the value of the <Arrest> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was arrested."

Returns:

The Arrest element of this object.

Since:

2.0

setArrest

public void setArrest(ArrestStatus value)

Sets the value of the <Arrest> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was arrested."

Parameters:

value - A constant defined by the ArrestStatus class

Since:

2.0

setArrest

public void setArrest(java.lang.String value)

Sets the value of the <Arrest> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was arrested."

Parameters:

value - The value as a String

Since:

2.0

getAlternativeEducation

public java.lang.String getAlternativeEducation()

Gets the value of the <AlternativeEducation> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was assigned to an Alternative Education facility."

Returns:

The AlternativeEducation element of this object.

Since:

2.0

setAlternativeEducation

public void setAlternativeEducation(YesNo value)

Sets the value of the <AlternativeEducation> element.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was assigned to an Alternative Education facility."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setAlternativeEducation

public void setAlternativeEducation(java.lang.String value)

Sets the value of the <AlternativeEducation> element as a String.

The SIF specification defines the meaning of this element as: "Identifies whether or not the offender was assigned to an Alternative Education facility."

Parameters:

value - The value as a String

Since:

2.0