com.edustructures.sifworks.student
Class ExitStatus

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFKeyedElement
              extended by com.edustructures.sifworks.student.ExitStatus
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class ExitStatus
extends SIFKeyedElement

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
ExitStatus()
          Constructor
ExitStatus(ExitStatusCode code)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.String getCode()
          Gets the value of the Code attribute.
 java.lang.String getKey()
          Gets the key of this object
 ElementDef[] getKeyFields()
          Gets the metadata fields that make up the key of this object
 OtherCodeList getOtherCodeList()
          Gets the value of the <OtherCodeList> element.
 void removeOtherCodeList()
          Removes the OtherCodeList child element previously created by calling setOtherCodeList
 void setCode(ExitStatusCode value)
          Sets the value of the Code attribute.
 void setCode(java.lang.String value)
          Sets the value of the Code attribute as a String.
 void setOtherCodeList(OtherCodeList value)
          Sets the value of the <OtherCodeList> element.
 java.lang.String toString()
          Returns the value of the Code attribute
 
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, 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExitStatus

public ExitStatus()
Constructor


ExitStatus

public ExitStatus(ExitStatusCode code)
Constructor that accepts values for all mandatory fields

Parameters:
code - Code indicating the exit status for this enrollment.
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

getCode

public java.lang.String getCode()
Gets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "Code indicating the exit status for this enrollment."

Returns:
The Code attribute of this object.
Since:
1.1

setCode

public void setCode(ExitStatusCode value)
Sets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "Code indicating the exit status for this enrollment."

Parameters:
value - A constant defined by the ExitStatusCode class
Since:
1.1

setCode

public void setCode(java.lang.String value)
Sets the value of the Code attribute as a String.

The SIF specification defines the meaning of this attribute as: "Code indicating the exit status for this enrollment."

Parameters:
value - The value as a String
Since:
1.1

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

toString

public java.lang.String toString()
Returns the value of the Code attribute

Overrides:
toString in class Element
Returns:
The text value of this element if applicable


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.