com.edustructures.sifworks.programs
Class ProgramExitReason

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.programs.ProgramExitReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ProgramExitReason
extends SIFElement

Required if student has exited the program.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

ProgramExitReason()
Constructor

ProgramExitReason(ProgramExitReasonCode codeType)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the <Code> element.
java.lang.String	getCodeType() Gets the value of the CodeType attribute.
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setCode(ProgramExitReasonCode value) Sets the value of the <Code> element.
void	setCode(java.lang.String value) Sets the value of the <Code> element as a String.
void	setCodeType(ProgramExitReasonCode value) Sets the value of the CodeType attribute.
void	setCodeType(java.lang.String value) Sets the value of the CodeType attribute as a String.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> 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

ProgramExitReason

public ProgramExitReason()

Constructor

ProgramExitReason

public ProgramExitReason(ProgramExitReasonCode codeType)

Constructor that accepts values for all mandatory fields

Parameters:

codeType - If value="NCES" then use code set 0815 Program Exit Reason [NCES Handbooks]

Method Detail

getCodeType

public java.lang.String getCodeType()

Gets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "If value="NCES" then use code set 0815 Program Exit Reason [NCES Handbooks]"

Returns:

The CodeType attribute of this object.

Since:

1.5r1

setCodeType

public void setCodeType(ProgramExitReasonCode value)

Sets the value of the CodeType attribute.

The SIF specification defines the meaning of this attribute as: "If value="NCES" then use code set 0815 Program Exit Reason [NCES Handbooks]"

Parameters:

value - A constant defined by the ProgramExitReasonCode class

Since:

1.5r1

setCodeType

public void setCodeType(java.lang.String value)

Sets the value of the CodeType attribute as a String.

The SIF specification defines the meaning of this attribute as: "If value="NCES" then use code set 0815 Program Exit Reason [NCES Handbooks]"

Parameters:

value - The value as a String

Since:

1.5r1

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Review by program / state. May be required if student has exited the program."

Returns:

The Code element of this object.

Since:

1.5r1

setCode

public void setCode(ProgramExitReasonCode value)

Sets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "Review by program / state. May be required if student has exited the program."

Parameters:

value - A constant defined by the ProgramExitReasonCode class

Since:

1.5r1

setCode

public void setCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Review by program / state. May be required if student has exited the program."

Parameters:

value - The value as a String

Since:

1.5r1

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0