Package com.boondocks.taxcontrols
Class Tax
- java.lang.Object
-
- com.boondocks.taxcontrols.Tax
-
public class Tax extends java.lang.Object
Class represents an individual tax formula.- Since:
- JDK1.1
- Version:
- 1.0
- Author:
- Caliber Technology LLC
-
-
Constructor Summary
Constructors Constructor Description Tax(java.lang.String name, java.lang.String scheme_formula, java.lang.String xml, java.lang.String pub, java.lang.String type, boolean withheld, boolean rnd_req, boolean rnd_opt, java.lang.String zip, java.lang.String effective, boolean nonres, java.lang.String home, java.lang.String work, java.lang.String before, java.lang.String after, java.lang.String formula)
For internal use only.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAuxiliaryInstructions()
Returns user Auxiliary instructions for this tax.java.lang.String
getAuxiliaryTag()
Returns the name used by this state for the auxiliary field.java.util.Date
getEffectiveDate()
Returns date when this tax begins.ContainerExpression
getExpression()
Used internally by TaxControls.java.lang.String
getHomeRule()
For internal use only.java.lang.String
getInstructions()
Returns user instructions for this tax.java.lang.String
getMiscellaneousInstructions()
Returns user Miscellaneous instructions for this tax.java.lang.String
getMiscellaneousTag()
Returns the name used by this state for the miscellaneous field.java.lang.String
getName()
Returns the name of this tax.java.lang.String
getPAZip()
Returns Range of Zip Codes for which taxes of type 'Home PA' must apply local rate.long
getPsd()
Returns the PSD Code (for PA EIT's) for this tax jurisdiction.java.lang.String
getPublished()
Returns information related to publication date for this tax.java.lang.String
getStateExemptionInstructions()
Returns user State Exemption instructions for this tax.java.lang.String
getStateExemptionTag()
Returns the name used by this state for exemptions.java.lang.String
getTaxType()
Returns tax type for this tax.java.lang.String
getWorkRule()
For internal use only.java.lang.String
getXMLInstructions()
Returns user instructions for this tax.java.lang.String
getZip()
Returns zip code range associated with this tax jurisdiction.int
getZipType()
Returns zip code type.float
Interpret(Environment env)
For internal use only.boolean
isDiscontinued()
Returns true if this tax has been discontinued.boolean
isNonResident()
Returns true if this tax is a nonresident local tax.boolean
isRoundingOptional()
Returns true if withholding for this tax can optionally be rounded to the nearest dollar amount.boolean
isRoundingRequired()
Returns true if withholding for this tax must be rounded to the nearest dollar amount.boolean
isWithheld()
Returns true if this tax is withheld from the employee's pay.void
setZip(java.lang.String z)
Sets zip code range associated with this tax jurisdiction.java.lang.String
toString()
float
Value(boolean subcalc, Environment env)
For internal use only.float
Value(Environment env)
For internal use only.
-
-
-
Constructor Detail
-
Tax
public Tax(java.lang.String name, java.lang.String scheme_formula, java.lang.String xml, java.lang.String pub, java.lang.String type, boolean withheld, boolean rnd_req, boolean rnd_opt, java.lang.String zip, java.lang.String effective, boolean nonres, java.lang.String home, java.lang.String work, java.lang.String before, java.lang.String after, java.lang.String formula)
For internal use only.
-
-
Method Detail
-
getExpression
public ContainerExpression getExpression()
Used internally by TaxControls.
-
getPublished
public java.lang.String getPublished()
Returns information related to publication date for this tax.- Returns:
- String containing publication information.
-
getTaxType
public java.lang.String getTaxType()
Returns tax type for this tax.- Returns:
- String containing type.
- See Also:
TaxControl.getTaxType()
-
isRoundingRequired
public boolean isRoundingRequired()
Returns true if withholding for this tax must be rounded to the nearest dollar amount.- Returns:
- Boolean indicating if withholding should be rounded.
- See Also:
TaxControl.isRoundingRequired()
-
isRoundingOptional
public boolean isRoundingOptional()
Returns true if withholding for this tax can optionally be rounded to the nearest dollar amount.- Returns:
- Boolean indicating if withholding may be rounded.
- See Also:
TaxControl.isRoundingOptional()
-
isDiscontinued
public boolean isDiscontinued()
Returns true if this tax has been discontinued.- Returns:
- Boolean indicating if withholding is discontinued.
- See Also:
TaxControl.isDiscontinued()
-
isWithheld
public boolean isWithheld()
Returns true if this tax is withheld from the employee's pay. Returns false if employer pays this tax.- Returns:
- Boolean indicating whether tax is withheld from employee.
-
isNonResident
public boolean isNonResident()
Returns true if this tax is a nonresident local tax.- Returns:
- boolean indicates whether tax is a "nonresident" tax.
-
getZip
public java.lang.String getZip()
Returns zip code range associated with this tax jurisdiction.- Returns:
- String Zip code(s) corresponding to this tax jurisdiction.
-
getZipType
public int getZipType()
Returns zip code type. Possible values are0 - Work (Tax employees whose workplace is in this zip code range)
1 - Home (Tax employees who live in this zip code range)
2 - HomePA (MD has a special case--If the employee resides in certain PA towns, he must pay the local MD rate. If he resides within MD, location of home determines rate. Anyone else pays a nonresident rate.)
- Returns:
- int Zip code type for this tax.
-
setZip
public void setZip(java.lang.String z)
Sets zip code range associated with this tax jurisdiction.- Parameters:
z
- String Zip code(s) corresponding to this tax jurisdiction.
-
getEffectiveDate
public java.util.Date getEffectiveDate()
Returns date when this tax begins.- Returns:
- Date Effective date of tax
-
getPAZip
public java.lang.String getPAZip()
Returns Range of Zip Codes for which taxes of type 'Home PA' must apply local rate. This range need only be included once in the entire table, usually within the first local MD tax.- Returns:
- String Zip code(s) in PA requiring local MD tax withholding.
-
getInstructions
public java.lang.String getInstructions()
Returns user instructions for this tax.- Returns:
- String containing instructions.
- See Also:
TaxControl.getInstructions()
-
getStateExemptionInstructions
public java.lang.String getStateExemptionInstructions()
Returns user State Exemption instructions for this tax.- Returns:
- String containing State Exemption instructions.
- See Also:
TaxControl.getInstructions()
-
getMiscellaneousInstructions
public java.lang.String getMiscellaneousInstructions()
Returns user Miscellaneous instructions for this tax.- Returns:
- String containing Miscellaneous instructions.
- See Also:
TaxControl.getInstructions()
-
getAuxiliaryInstructions
public java.lang.String getAuxiliaryInstructions()
Returns user Auxiliary instructions for this tax.- Returns:
- String containing Auxiliary instructions.
- See Also:
TaxControl.getInstructions()
-
getXMLInstructions
public java.lang.String getXMLInstructions()
Returns user instructions for this tax.- Returns:
- String containing instructions formatted as xml.
- See Also:
TaxControl.getInstructions()
-
getWorkRule
public java.lang.String getWorkRule()
For internal use only.
-
getHomeRule
public java.lang.String getHomeRule()
For internal use only.
-
getName
public java.lang.String getName()
Returns the name of this tax.- Returns:
- String holding name of tax.
-
getStateExemptionTag
public java.lang.String getStateExemptionTag()
Returns the name used by this state for exemptions.- Returns:
- String holding tag.
-
getMiscellaneousTag
public java.lang.String getMiscellaneousTag()
Returns the name used by this state for the miscellaneous field.- Returns:
- String holding tag.
-
getPsd
public long getPsd()
Returns the PSD Code (for PA EIT's) for this tax jurisdiction.- Returns:
- long PSD Code
-
getAuxiliaryTag
public java.lang.String getAuxiliaryTag()
Returns the name used by this state for the auxiliary field.- Returns:
- String holding tag.
-
Interpret
public float Interpret(Environment env)
For internal use only.
-
Value
public float Value(boolean subcalc, Environment env) throws TaxControlException
For internal use only.- Throws:
TaxControlException
-
Value
public float Value(Environment env) throws TaxControlException
For internal use only.- Throws:
TaxControlException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-