com.edustructures.sifworks.etranscripts
Class ActivityAward

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.etranscripts.ActivityAward

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ActivityAward
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

ActivityAward()
Constructor

Method Summary

java.lang.String	getDiplomaCredentialHonorsCode() Gets the value of the <DiplomaCredentialHonorsCode> element.
java.lang.String	getDiplomaCredentialHonorsDescription() Gets the value of the <DiplomaCredentialHonorsDescription> element.
java.lang.String	getHonorsDescription() Gets the value of the <HonorsDescription> element.
java.lang.String	getHonorsInformationCode() Gets the value of the <HonorsInformationCode> element.
java.lang.String	getInvolvementAmount() Gets the value of the <InvolvementAmount> element.
PartialDateType	getInvolvementBeginningDate() Gets the value of the <InvolvementBeginningDate> element.
java.lang.String	getInvolvementCode() Gets the value of the <InvolvementCode> element.
PartialDateType	getInvolvementEndingDate() Gets the value of the <InvolvementEndingDate> element.
java.lang.String	getName() Gets the value of the <Name> element.
void	removeInvolvementBeginningDate() Removes the InvolvementBeginningDate child element previously created by calling setInvolvementBeginningDate
void	removeInvolvementEndingDate() Removes the InvolvementEndingDate child element previously created by calling setInvolvementEndingDate
void	setDiplomaCredentialHonorsCode(DiplomaCredentialAndHonorsType value) Sets the value of the <DiplomaCredentialHonorsCode> element.
void	setDiplomaCredentialHonorsCode(java.lang.String value) Sets the value of the <DiplomaCredentialHonorsCode> element as a String.
void	setDiplomaCredentialHonorsDescription(java.lang.String value) Sets the value of the <DiplomaCredentialHonorsDescription> element.
void	setHonorsDescription(java.lang.String value) Sets the value of the <HonorsDescription> element.
void	setHonorsInformationCode(HonorsInformationCode value) Sets the value of the <HonorsInformationCode> element.
void	setHonorsInformationCode(java.lang.String value) Sets the value of the <HonorsInformationCode> element as a String.
void	setInvolvementAmount(java.lang.String value) Sets the value of the <InvolvementAmount> element.
void	setInvolvementBeginningDate(PartialDateType value) Sets the value of the <InvolvementBeginningDate> element.
void	setInvolvementBeginningDate(java.lang.String value) Sets the value of the <InvolvementBeginningDate> child element.
void	setInvolvementCode(ActivityInvolvementCode value) Sets the value of the <InvolvementCode> element.
void	setInvolvementCode(java.lang.String value) Sets the value of the <InvolvementCode> element as a String.
void	setInvolvementEndingDate(PartialDateType value) Sets the value of the <InvolvementEndingDate> element.
void	setInvolvementEndingDate(java.lang.String value) Sets the value of the <InvolvementEndingDate> child element.
void	setName(java.lang.String value) Sets the value of the <Name> 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

ActivityAward

public ActivityAward()

Constructor

Method Detail

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The title that identifies a particular co-curricular or extra-curricular activity."

Returns:

The Name element of this object.

Since:

2.0

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The title that identifies a particular co-curricular or extra-curricular activity."

Parameters:

value - A String object

Since:

2.0

getInvolvementCode

public java.lang.String getInvolvementCode()

Gets the value of the <InvolvementCode> element.

The SIF specification defines the meaning of this element as: "The code used to identify the co-curricular or extra-curricular activity in which the individual is involved."

Returns:

The InvolvementCode element of this object.

Since:

2.0

setInvolvementCode

public void setInvolvementCode(ActivityInvolvementCode value)

Sets the value of the <InvolvementCode> element.

The SIF specification defines the meaning of this element as: "The code used to identify the co-curricular or extra-curricular activity in which the individual is involved."

Parameters:

value - A constant defined by the ActivityInvolvementCode class

Since:

2.0

setInvolvementCode

public void setInvolvementCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The code used to identify the co-curricular or extra-curricular activity in which the individual is involved."

Parameters:

value - The value as a String

Since:

2.0

setInvolvementBeginningDate

public void setInvolvementBeginningDate(PartialDateType value)

Sets the value of the <InvolvementBeginningDate> element.

The SIF specification defines the meaning of this element as: "The month, day, and year on which the individual began to participate in the activity."

Parameters:

value - A PartialDateType object

Since:

2.0

setInvolvementBeginningDate

public void setInvolvementBeginningDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getInvolvementBeginningDate

public PartialDateType getInvolvementBeginningDate()

Gets the value of the <InvolvementBeginningDate> element.

The SIF specification defines the meaning of this element as: "The month, day, and year on which the individual began to participate in the activity."

Returns:

A PartialDateType object

Since:

2.0

removeInvolvementBeginningDate

public void removeInvolvementBeginningDate()

Removes the InvolvementBeginningDate child element previously created by calling setInvolvementBeginningDate

Since:

2.0

setInvolvementEndingDate

public void setInvolvementEndingDate(PartialDateType value)

Sets the value of the <InvolvementEndingDate> element.

The SIF specification defines the meaning of this element as: "The month, day, and year on which the individual ceased to participate in the activity."

Parameters:

value - A PartialDateType object

Since:

2.0

setInvolvementEndingDate

public void setInvolvementEndingDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getInvolvementEndingDate

public PartialDateType getInvolvementEndingDate()

Gets the value of the <InvolvementEndingDate> element.

The SIF specification defines the meaning of this element as: "The month, day, and year on which the individual ceased to participate in the activity."

Returns:

A PartialDateType object

Since:

2.0

removeInvolvementEndingDate

public void removeInvolvementEndingDate()

Removes the InvolvementEndingDate child element previously created by calling setInvolvementEndingDate

Since:

2.0

getInvolvementAmount

public java.lang.String getInvolvementAmount()

Gets the value of the <InvolvementAmount> element.

The SIF specification defines the meaning of this element as: "An indication of the degree to which the individual is involved in the activity (e.g., number of hours per week)."

Returns:

The InvolvementAmount element of this object.

Since:

2.0

setInvolvementAmount

public void setInvolvementAmount(java.lang.String value)

Sets the value of the <InvolvementAmount> element.

The SIF specification defines the meaning of this element as: "An indication of the degree to which the individual is involved in the activity (e.g., number of hours per week)."

Parameters:

value - A String object

Since:

2.0

getHonorsInformationCode

public java.lang.String getHonorsInformationCode()

Gets the value of the <HonorsInformationCode> element.

The SIF specification defines the meaning of this element as: "A designation of the type of academic distinctions or other honors earned by or awarded to the student."

Returns:

The HonorsInformationCode element of this object.

Since:

2.0

setHonorsInformationCode

public void setHonorsInformationCode(HonorsInformationCode value)

Sets the value of the <HonorsInformationCode> element.

The SIF specification defines the meaning of this element as: "A designation of the type of academic distinctions or other honors earned by or awarded to the student."

Parameters:

value - A constant defined by the HonorsInformationCode class

Since:

2.0

setHonorsInformationCode

public void setHonorsInformationCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "A designation of the type of academic distinctions or other honors earned by or awarded to the student."

Parameters:

value - The value as a String

Since:

2.0

getHonorsDescription

public java.lang.String getHonorsDescription()

Gets the value of the <HonorsDescription> element.

The SIF specification defines the meaning of this element as: "A textual description of the distinction or honor."

Returns:

The HonorsDescription element of this object.

Since:

2.0

setHonorsDescription

public void setHonorsDescription(java.lang.String value)

Sets the value of the <HonorsDescription> element.

The SIF specification defines the meaning of this element as: "A textual description of the distinction or honor."

Parameters:

value - A String object

Since:

2.0

getDiplomaCredentialHonorsCode

public java.lang.String getDiplomaCredentialHonorsCode()

Gets the value of the <DiplomaCredentialHonorsCode> element.

The SIF specification defines the meaning of this element as: "The nature of recognition given the student for the successful completion of work in high school."

Returns:

The DiplomaCredentialHonorsCode element of this object.

Since:

2.0

setDiplomaCredentialHonorsCode

public void setDiplomaCredentialHonorsCode(DiplomaCredentialAndHonorsType value)

Sets the value of the <DiplomaCredentialHonorsCode> element.

The SIF specification defines the meaning of this element as: "The nature of recognition given the student for the successful completion of work in high school."

Parameters:

value - A constant defined by the DiplomaCredentialAndHonorsType class

Since:

2.0

setDiplomaCredentialHonorsCode

public void setDiplomaCredentialHonorsCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The nature of recognition given the student for the successful completion of work in high school."

Parameters:

value - The value as a String

Since:

2.0

getDiplomaCredentialHonorsDescription

public java.lang.String getDiplomaCredentialHonorsDescription()

Gets the value of the <DiplomaCredentialHonorsDescription> element.

The SIF specification defines the meaning of this element as: "A textual description of the recognition."

Returns:

The DiplomaCredentialHonorsDescription element of this object.

Since:

2.0

setDiplomaCredentialHonorsDescription

public void setDiplomaCredentialHonorsDescription(java.lang.String value)

Sets the value of the <DiplomaCredentialHonorsDescription> element.

The SIF specification defines the meaning of this element as: "A textual description of the recognition."

Parameters:

value - A String object

Since:

2.0