com.edustructures.sifworks.hrfin
Class W4

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.hrfin.W4

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class W4
extends SIFDataObject

This object contains the information completed on a W4 tax form. (Please note that this object is defined to represent the current deductions allowances for the employee; this is not intended to circumvent or replace IRS reporting standards but to faciliatate movement of W4 data from system to system within the LEA.) 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

W4()
Constructor

W4(java.lang.String employeePersonalRefId, java.util.Calendar w4Date, MaritalStatusRate maritalStatusRate, java.lang.Integer federalAllowancesNumber, StatePrCode stateProvince, java.lang.Boolean exempt)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEmployeePersonalRefId() Gets the value of the EmployeePersonalRefId attribute.
java.lang.Boolean	getExempt() Gets the value of the <Exempt> element.
java.lang.Integer	getFederalAllowancesNumber() Gets the value of the <FederalAllowancesNumber> 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	getMaritalStatusRate() Gets the value of the <MaritalStatusRate> element.
java.lang.Integer	getStateAllowancesNumber() Gets the value of the <StateAllowancesNumber> element.
java.lang.String	getStateProvince() Gets the value of the <StateProvince> element.
java.util.Calendar	getW4Date() Gets the value of the <W4Date> element.
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the EmployeePersonalRefId attribute.
void	setExempt(java.lang.Boolean value) Sets the value of the <Exempt> element.
void	setFederalAllowancesNumber(java.lang.Integer value) Sets the value of the <FederalAllowancesNumber> element.
void	setMaritalStatusRate(MaritalStatusRate value) Sets the value of the <MaritalStatusRate> element.
void	setMaritalStatusRate(java.lang.String value) Sets the value of the <MaritalStatusRate> element as a String.
void	setStateAllowancesNumber(java.lang.Integer value) Sets the value of the <StateAllowancesNumber> element.
void	setStateProvince(StatePrCode value) Sets the value of the <StateProvince> element.
void	setStateProvince(java.lang.String value) Sets the value of the <StateProvince> element as a String.
void	setW4Date(java.util.Calendar value) Sets the value of the <W4Date> 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

W4

public W4()

Constructor

W4

public W4(java.lang.String employeePersonalRefId,
          java.util.Calendar w4Date,
          MaritalStatusRate maritalStatusRate,
          java.lang.Integer federalAllowancesNumber,
          StatePrCode stateProvince,
          java.lang.Boolean exempt)

Constructor that accepts values for all mandatory fields

Parameters:

employeePersonalRefId - This is the GUID that points to the employee represented in the EmployeePersonal object.

w4Date - Date W4 was completed.

maritalStatusRate - This denotes the current martial status of the employee

federalAllowancesNumber - Number of federal allowances.

stateProvince - State of residence.

exempt - Is this employee exempt from federal and state exemptions?

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

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the GUID that points to the employee represented in the 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: "This is the GUID that points to the employee represented in the EmployeePersonal object."

Parameters:

value - A String object

Since:

1.5r1

getW4Date

public java.util.Calendar getW4Date()

Gets the value of the <W4Date> element.

The SIF specification defines the meaning of this element as: "Date W4 was completed."

Returns:

The W4Date element of this object.

Since:

1.5r1

setW4Date

public void setW4Date(java.util.Calendar value)

Sets the value of the <W4Date> element.

The SIF specification defines the meaning of this element as: "Date W4 was completed."

Parameters:

value - A Calendar object

Since:

1.5r1

getMaritalStatusRate

public java.lang.String getMaritalStatusRate()

Gets the value of the <MaritalStatusRate> element.

The SIF specification defines the meaning of this element as: "This denotes the current martial status of the employee"

Returns:

The MaritalStatusRate element of this object.

Since:

1.5r1

setMaritalStatusRate

public void setMaritalStatusRate(MaritalStatusRate value)

Sets the value of the <MaritalStatusRate> element.

The SIF specification defines the meaning of this element as: "This denotes the current martial status of the employee"

Parameters:

value - A constant defined by the MaritalStatusRate class

Since:

1.5r1

setMaritalStatusRate

public void setMaritalStatusRate(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "This denotes the current martial status of the employee"

Parameters:

value - The value as a String

Since:

1.5r1

getFederalAllowancesNumber

public java.lang.Integer getFederalAllowancesNumber()

Gets the value of the <FederalAllowancesNumber> element.

The SIF specification defines the meaning of this element as: "Number of federal allowances."

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	"FedAllowancesNumber"
SIF2.0	"FederalAllowancesNumber"

Returns:

The FederalAllowancesNumber element of this object.

Since:

1.5r1

setFederalAllowancesNumber

public void setFederalAllowancesNumber(java.lang.Integer value)

Sets the value of the <FederalAllowancesNumber> element.

The SIF specification defines the meaning of this element as: "Number of federal allowances."

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	"FedAllowancesNumber"
SIF2.0	"FederalAllowancesNumber"

Parameters:

value - A Integer object

Since:

1.5r1

getStateAllowancesNumber

public java.lang.Integer getStateAllowancesNumber()

Gets the value of the <StateAllowancesNumber> element.

The SIF specification defines the meaning of this element as: "Number of state allowances."

Returns:

The StateAllowancesNumber element of this object.

Since:

1.5r1

setStateAllowancesNumber

public void setStateAllowancesNumber(java.lang.Integer value)

Sets the value of the <StateAllowancesNumber> element.

The SIF specification defines the meaning of this element as: "Number of state allowances."

Parameters:

value - A Integer object

Since:

1.5r1

getStateProvince

public java.lang.String getStateProvince()

Gets the value of the <StateProvince> element.

The SIF specification defines the meaning of this element as: "State of residence."

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	"StatePr"
SIF2.0	"StateProvince"

Returns:

The StateProvince element of this object.

Since:

1.5r1

setStateProvince

public void setStateProvince(StatePrCode value)

Sets the value of the <StateProvince> element.

The SIF specification defines the meaning of this element as: "State of residence."

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	"StatePr"
SIF2.0	"StateProvince"

Parameters:

value - A constant defined by the StatePrCode class

Since:

1.5r1

setStateProvince

public void setStateProvince(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "State of residence."

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	"StatePr"
SIF2.0	"StateProvince"

Parameters:

value - The value as a String

Since:

1.5r1

getExempt

public java.lang.Boolean getExempt()

Gets the value of the <Exempt> element.

The SIF specification defines the meaning of this element as: "Is this employee exempt from federal and state exemptions?"

Returns:

The Exempt element of this object.

Since:

1.5r1

setExempt

public void setExempt(java.lang.Boolean value)

Sets the value of the <Exempt> element.

The SIF specification defines the meaning of this element as: "Is this employee exempt from federal and state exemptions?"

Parameters:

value - A Boolean object

Since:

1.5r1