com.edustructures.sifworks.profdev
Class EmployeeRecertification

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeeRecertification
extends SIFDataObject

This object contains information about employee continuing professional course and activity credits and hours taken by employees for recertification purposes. It is used as a vertical reporting snapshot-type object to transmit information regarding professional continuing education courses and activities completed by employees to maintain their current educational certification(s) within a given state. SIF_Events are not 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

EmployeeRecertification()
Constructor

EmployeeRecertification(java.lang.String ssn, java.lang.String stateProvinceId, Name name, java.lang.String activityName, ActivityType activityType, java.math.BigDecimal activityHours, Earned earned, java.util.Calendar dateFrom, java.util.Calendar dateTo)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getActivityHours() Gets the value of the <ActivityHours> element.
java.lang.String	getActivityName() Gets the value of the <ActivityName> element.
java.lang.String	getActivityType() Gets the value of the <ActivityType> element.
java.util.Calendar	getDateFrom() Gets the value of the <DateFrom> element.
java.util.Calendar	getDateTo() Gets the value of the <DateTo> element.
Demographics	getDemographics() Gets the value of the <Demographics> element.
Earned	getEarned() Gets the value of the <Earned> 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
Name	getName() Gets the value of the <Name> element.
java.lang.String	getSSN() Gets the value of the <SSN> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
void	removeDemographics() Removes the Demographics child element previously created by calling setDemographics
void	removeEarned() Removes the Earned child element previously created by calling setEarned
void	removeName() Removes the Name child element previously created by calling setName
void	setActivityHours(java.math.BigDecimal value) Sets the value of the <ActivityHours> element.
void	setActivityName(java.lang.String value) Sets the value of the <ActivityName> element.
void	setActivityType(ActivityType value) Sets the value of the <ActivityType> element.
void	setActivityType(java.lang.String value) Sets the value of the <ActivityType> element as a String.
void	setDateFrom(java.util.Calendar value) Sets the value of the <DateFrom> element.
void	setDateTo(java.util.Calendar value) Sets the value of the <DateTo> element.
void	setDemographics(Demographics value) Sets the value of the <Demographics> element.
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	setName(Name value) Sets the value of the <Name> element.
void	setName(NameType type, java.lang.String lastName, java.lang.String firstName) Sets the value of the <Name> child element.
void	setSSN(java.lang.String value) Sets the value of the <SSN> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, 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

EmployeeRecertification

public EmployeeRecertification()

Constructor

EmployeeRecertification

public EmployeeRecertification(java.lang.String ssn,
                               java.lang.String stateProvinceId,
                               Name name,
                               java.lang.String activityName,
                               ActivityType activityType,
                               java.math.BigDecimal activityHours,
                               Earned earned,
                               java.util.Calendar dateFrom,
                               java.util.Calendar dateTo)

Constructor that accepts values for all mandatory fields

Parameters:

ssn - Employee Social Security Number. This element or StateProvinceId, or both, must be included.

stateProvinceId - The state-assigned identifier for this staff member. This element or SSN, or both, must be included.

name - Name of employee.

activityName - Name of the course or activity

activityType - Type of course or activity

activityHours - Total activity hours/total clock hours

earned - Hours attended or credits earned by the employee

dateFrom - Start date of the course or activity

dateTo - Source: 0613 Employment Status

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

getSSN

public java.lang.String getSSN()

Gets the value of the <SSN> element.

The SIF specification defines the meaning of this element as: "Employee Social Security Number. This element or StateProvinceId, or both, must be included."

This element 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 elements of this kind.

Version	Tag
1.5r1	"Ssn"
SIF2.0	"SSN"

Returns:

The SSN element of this object.

Since:

1.5r1

setSSN

public void setSSN(java.lang.String value)

Sets the value of the <SSN> element.

The SIF specification defines the meaning of this element as: "Employee Social Security Number. This element or StateProvinceId, or both, must be included."

This element 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 elements of this kind.

Version	Tag
1.5r1	"Ssn"
SIF2.0	"SSN"

Parameters:

value - A String object

Since:

1.5r1

getStateProvinceId

public java.lang.String getStateProvinceId()

Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state-assigned identifier for this staff member. This element or SSN, or both, must be included."

Returns:

The StateProvinceId element of this object.

Since:

2.0

setStateProvinceId

public void setStateProvinceId(java.lang.String value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state-assigned identifier for this staff member. This element or SSN, or both, must be included."

Parameters:

value - A String object

Since:

2.0

setName

public void setName(Name value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of employee."

Parameters:

value - A Name object

Since:

1.5r1

setName

public void setName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)

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

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Since:

1.5r1

getName

public Name getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of employee."

Returns:

A Name object

Since:

1.5r1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

1.5r1

setDemographics

public void setDemographics(Demographics value)

Sets the value of the <Demographics> element.

The SIF specification defines the meaning of this element as: "This element contains information related to employee demographics."

Parameters:

value - A Demographics object

Since:

1.5r1

getDemographics

public Demographics getDemographics()

Gets the value of the <Demographics> element.

The SIF specification defines the meaning of this element as: "This element contains information related to employee demographics."

Returns:

A Demographics object

Since:

1.5r1

removeDemographics

public void removeDemographics()

Removes the Demographics child element previously created by calling setDemographics

Since:

1.5r1

getActivityName

public java.lang.String getActivityName()

Gets the value of the <ActivityName> element.

The SIF specification defines the meaning of this element as: "Name of the course or activity"

Returns:

The ActivityName element of this object.

Since:

1.5r1

setActivityName

public void setActivityName(java.lang.String value)

Sets the value of the <ActivityName> element.

The SIF specification defines the meaning of this element as: "Name of the course or activity"

Parameters:

value - A String object

Since:

1.5r1

getActivityType

public java.lang.String getActivityType()

Gets the value of the <ActivityType> element.

The SIF specification defines the meaning of this element as: "Type of course or activity"

Returns:

The ActivityType element of this object.

Since:

1.5r1

setActivityType

public void setActivityType(ActivityType value)

Sets the value of the <ActivityType> element.

The SIF specification defines the meaning of this element as: "Type of course or activity"

Parameters:

value - A constant defined by the ActivityType class

Since:

1.5r1

setActivityType

public void setActivityType(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Type of course or activity"

Parameters:

value - The value as a String

Since:

1.5r1

getActivityHours

public java.math.BigDecimal getActivityHours()

Gets the value of the <ActivityHours> element.

The SIF specification defines the meaning of this element as: "Total activity hours/total clock hours"

Returns:

The ActivityHours element of this object.

Since:

1.5r1

setActivityHours

public void setActivityHours(java.math.BigDecimal value)

Sets the value of the <ActivityHours> element.

The SIF specification defines the meaning of this element as: "Total activity hours/total clock hours"

Parameters:

value - A BigDecimal 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: "Hours attended or credits earned by the employee"

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: "Hours attended or credits earned by the employee"

Returns:

An Earned object

Since:

1.5r1

removeEarned

public void removeEarned()

Removes the Earned child element previously created by calling setEarned

Since:

1.5r1

getDateFrom

public java.util.Calendar getDateFrom()

Gets the value of the <DateFrom> element.

The SIF specification defines the meaning of this element as: "Start date of the course or activity"

Returns:

The DateFrom element of this object.

Since:

1.5r1

setDateFrom

public void setDateFrom(java.util.Calendar value)

Sets the value of the <DateFrom> element.

The SIF specification defines the meaning of this element as: "Start date of the course or activity"

Parameters:

value - A Calendar object

Since:

1.5r1

getDateTo

public java.util.Calendar getDateTo()

Gets the value of the <DateTo> element.

The SIF specification defines the meaning of this element as: "Source: 0613 Employment Status"

Returns:

The DateTo element of this object.

Since:

1.5r1

setDateTo

public void setDateTo(java.util.Calendar value)

Sets the value of the <DateTo> element.

The SIF specification defines the meaning of this element as: "Source: 0613 Employment Status"

Parameters:

value - A Calendar object

Since:

1.5r1