com.edustructures.sifworks.profdev
Class EmployeeCredit

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.profdev.EmployeeCredit

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeeCredit
extends SIFDataObject

This object contains information about courses and activities taken by employees. SIF_Events are reported.

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

EmployeeCredit()
Constructor

EmployeeCredit(java.lang.String refId, java.lang.String employeePersonalRefId, java.lang.String professionalDevelopmentActivitiesRefId, java.util.Calendar endDate, Earned earned)
Constructor that accepts values for all mandatory fields

Method Summary

Earned	getEarned() Gets the value of the <Earned> element.
java.lang.String	getEmployeePersonalRefId() Gets the value of the EmployeePersonalRefId attribute.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> 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
java.lang.String	getProfessionalDevelopmentActivitiesRefId() Gets the value of the ProfessionalDevelopmentActivitiesRefId attribute.
java.lang.String	getRefId() Gets the value of the RefId attribute.
void	removeEarned() Removes the Earned child element previously created by calling setEarned
void	setEarned(Earned value) Sets the value of the <Earned> element.
void	setEarned(EarnedType type, java.lang.String value) Sets the value of the <Earned> child element.
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the EmployeePersonalRefId attribute.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setProfessionalDevelopmentActivitiesRefId(java.lang.String value) Sets the value of the ProfessionalDevelopmentActivitiesRefId attribute.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.

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

EmployeeCredit

public EmployeeCredit()

Constructor

EmployeeCredit

public EmployeeCredit(java.lang.String refId,
                      java.lang.String employeePersonalRefId,
                      java.lang.String professionalDevelopmentActivitiesRefId,
                      java.util.Calendar endDate,
                      Earned earned)

Constructor that accepts values for all mandatory fields

Parameters:

refId - This is the GUID for this object.

employeePersonalRefId - References EmployeePersonal object.

professionalDevelopmentActivitiesRefId - References the ProfDevActivities object

endDate - Date in which the course or activity was completed and awarded credit.

earned - The number of units earned

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: "This is the GUID for this object."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

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: "This is the GUID for this object."

Parameters:

value - A String object

Since:

1.5r1

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "References EmployeePersonal object."

Returns:

The EmployeePersonalRefId attribute of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "References EmployeePersonal object."

Parameters:

value - A String object

Since:

1.5r1

getProfessionalDevelopmentActivitiesRefId

public java.lang.String getProfessionalDevelopmentActivitiesRefId()

Gets the value of the ProfessionalDevelopmentActivitiesRefId attribute.

The SIF specification defines the meaning of this attribute as: "References the ProfDevActivities object"

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"ProfDevActivitiesRefId"
SIF2.0	"ProfessionalDevelopmentActivitiesRefId"

Returns:

The ProfessionalDevelopmentActivitiesRefId attribute of this object.

Since:

1.5r1

setProfessionalDevelopmentActivitiesRefId

public void setProfessionalDevelopmentActivitiesRefId(java.lang.String value)

Sets the value of the ProfessionalDevelopmentActivitiesRefId attribute.

The SIF specification defines the meaning of this attribute as: "References the ProfDevActivities object"

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"ProfDevActivitiesRefId"
SIF2.0	"ProfessionalDevelopmentActivitiesRefId"

Parameters:

value - A String object

Since:

1.5r1

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Date in which the course or activity was completed and awarded credit."

Returns:

The EndDate element of this object.

Since:

1.5r1

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: "Date in which the course or activity was completed and awarded credit."

Parameters:

value - A Calendar object

Since:

1.5r1

setEarned

public void setEarned(Earned value)

Sets the value of the <Earned> element.

The SIF specification defines the meaning of this element as: "The number of units earned"

Parameters:

value - A Earned object

Since:

1.5r1

setEarned

public void setEarned(EarnedType type,
                      java.lang.String value)

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

Parameters:

type - The unit description

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

Since:

1.5r1

getEarned

public Earned getEarned()

Gets the value of the <Earned> element.

The SIF specification defines the meaning of this element as: "The number of units earned"

Returns:

An Earned object

Since:

1.5r1

removeEarned

public void removeEarned()

Removes the Earned child element previously created by calling setEarned

Since:

1.5r1