com.met.cptl
Interface Cptl

All Known Implementing Classes:
CptlManager

public interface Cptl


Method Summary
 CptlResult calcDeductions(EmployeeData empInfo)
          calcDeductions(EmployeeData empInfo) returns a CptlResult object with results of calculated required CRA payroll deductions, including deduction amounts for Canada Pension Plan (CPP), Employment Insurance (EI), and Income Tax (federal and Provincial/Territorial, excluding Quebec).
 int calcIndexedTD1Claim(int TD1BaseClaim, int TD1NoIndexAmount)
          calcIndexedTD1Claim(int TD1BaseClaim, int TD1NoIndexAmount) returns the current year's indexed federal TD1 Claim Amount for the specified previous year TD1 total claim amount (TD1BaseClaim) and non-indexable previous year TD1 claim amount (TD1NoIndexAmount).
 int calcIndexedTD1PClaim(java.lang.String aProv, int TD1PBaseClaim, int TD1PNoIndexAmount)
          calcIndexedTD1PClaim(String aProv, int TD1PBaseClaim, int TD1PNoIndexAmount) returns the current year's indexed provincial/territorial TD1P Claim Amount for the specified province (aProv), previous year TD1P total claim amount (TD1PBaseClaim) and non-indexable previous year TD1P claim amount (TD1PNoIndexAmount).
 java.lang.String getEffDate()
          getEffDate() returns a string value in the ISO 8601 date format YYYY-MM-DD, which indicates the effective date for this version of CptlManager instance.
 int getMaxCPP()
          getMaxCPP() returns an integer value equal to the maximum annual employee CPP deduction for the current taxation year.
 int getMaxCPPearnings()
          getMaxCPPearnings() returns an integer value equal to the maximum annual employee CPP pensionable earnings for the current taxation year.
 int getMaxEI(java.lang.String aProv)
          getMaxEI(String aProv) returns an integer value equal to the maximum annual employee EI deduction for the current taxation year.
 int getMaxEIearnings(java.lang.String aProv)
          getMaxEIearnings(String aProv) returns an integer value equal to the maximum annual employee EI insurable earnings for the current taxation year.
 int getTaxYear()
          getTaxYear() returns the taxation year the current CptlManager has been released for.
 int getTD1Claim(int claimCode)
          getTD1Claim(int claimCode) returns the value of the federal TD1 Claim Amount associated with the specified TD1 claim code.
 int getTD1ClaimCode(int TD1_ClaimAmount)
          getTD1ClaimCode(int TD1_ClaimAmount) returns the federal TD1 Claim Code associated with the specified TD1 claim amount.
 int getTD1ClaimRange(int claimCode)
          getTD1ClaimRange(int claimCode) returns the upper value of the federal TD1 Claim Code range associated with the specified TD1 claim code.
 int getTD1PClaim(java.lang.String aProv, int claimCode)
          getTD1PClaim(String aProv, int claimCode) returns the value of the provincial/territorial TD1P Claim Amount associated with the specified province and TD1P claim code.
 int getTD1PClaimCode(java.lang.String aProv, int TD1P_ClaimAmount)
          getTD1PClaimCode(String aProv, int TD1P_ClaimAmount) feturns the provincial/territorial TD1P Claim Code associated with the specified TD1P claim amount.
 int getTD1PClaimRange(java.lang.String aProv, int claimCode)
          getTD1PClaimRange(String aProv, int claimCode) returns the upper value of the provincial/territorial TD1P Claim Code range associated with the specified TD1P claim code.
 java.lang.String getVersion()
          getVersion() returns the version identification string for the current CptlManager instance.
 

Method Detail

calcDeductions

CptlResult calcDeductions(EmployeeData empInfo)
                          throws CptlException
calcDeductions(EmployeeData empInfo) returns a CptlResult object with results of calculated required CRA payroll deductions, including deduction amounts for Canada Pension Plan (CPP), Employment Insurance (EI), and Income Tax (federal and Provincial/Territorial, excluding Quebec).

Use this method to calculate employee payroll deductions for any payroll date beginning with the current effective date of CptlManager class (use CptlManager.getEffDate() method), and up to December 31 of the current taxation year of CptlManager class (use CptlManager.getTaxYear() method).

Parameters:
empInfo - An EmployeeData object containing all the input data related to the requested payroll calculation.
Returns:
CptlResult object with calculated required CRA payroll deductions.
Throws:
CptlException

getVersion

java.lang.String getVersion()
                            throws CptlException
getVersion() returns the version identification string for the current CptlManager instance. The version string has the following format: CPTLW.yyyyX.Y.Z, where: yyyy = calendar tax year X = tax year update identifier (A = Jan 1; B = Jul 1) Y = major release number (is used for major updates) Z = minor release number (is used for minor updates/bug fixes)

Returns:
Version identification string for the current CptlManager() instance.
Throws:
CptlException

getTaxYear

int getTaxYear()
               throws CptlException
getTaxYear() returns the taxation year the current CptlManager has been released for. The library cannot be used for payroll dates that are after this year.

Returns:
Integer value equal to calendar taxation year
Throws:
CptlException

getEffDate

java.lang.String getEffDate()
                            throws CptlException
getEffDate() returns a string value in the ISO 8601 date format YYYY-MM-DD, which indicates the effective date for this version of CptlManager instance. This is the date that the most recent version of Cptl class is effective for, or the date that the current version of CptlManager becomes effective.

Returns:
String value in the ISO 8601 date format YYYY-MM-DD
Throws:
CptlException

getTD1Claim

int getTD1Claim(int claimCode)
                throws CptlException
getTD1Claim(int claimCode) returns the value of the federal TD1 Claim Amount associated with the specified TD1 claim code.

Parameters:
claimCode - The TD1 claim code. Valid values: 0-10. Use claimCode = 1 to obtain the default Basic Federal Claim Amount.
Returns:
Integer value of the federal TD1 Claim Amount rounded to the nearest penny. This value is expressed in whole cents - e.g. the value 11138.00 will be returned as 1113800
Throws:
CptlException

getTD1ClaimRange

int getTD1ClaimRange(int claimCode)
                     throws CptlException
getTD1ClaimRange(int claimCode) returns the upper value of the federal TD1 Claim Code range associated with the specified TD1 claim code.

Parameters:
claimCode - The TD1 claim code. Valid values: 0-10. Use claimCode = 1 to obtain the default Basic Federal Claim Amount.
Returns:
Integer value of the federal TD1 Claim Amount rounded to the nearest penny. This value is expressed in whole cents - e.g. the value 11138.00 will be returned as 1113800
Throws:
CptlException

getTD1ClaimCode

int getTD1ClaimCode(int TD1_ClaimAmount)
                    throws CptlException
getTD1ClaimCode(int TD1_ClaimAmount) returns the federal TD1 Claim Code associated with the specified TD1 claim amount.

Parameters:
TD1_ClaimAmount - The federal TD1 claim amount rounded to the nearest whole penny Ð e.g. the value 11138.00 should be passed as 1113800
Returns:
Integer value of the federal TD1 Claim Code (0-10).
Throws:
CptlException

calcIndexedTD1Claim

int calcIndexedTD1Claim(int TD1BaseClaim,
                        int TD1NoIndexAmount)
                        throws CptlException
calcIndexedTD1Claim(int TD1BaseClaim, int TD1NoIndexAmount) returns the current year's indexed federal TD1 Claim Amount for the specified previous year TD1 total claim amount (TD1BaseClaim) and non-indexable previous year TD1 claim amount (TD1NoIndexAmount).

Parameters:
TD1BaseClaim - previous year TD1 total claim amount.
TD1NoIndexAmount - previous year non-indexable portion of TD1 total claim amount.
Returns:
Integer value of the calculated indexed TD1 total claim amount for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException

getTD1PClaim

int getTD1PClaim(java.lang.String aProv,
                 int claimCode)
                 throws CptlException
getTD1PClaim(String aProv, int claimCode) returns the value of the provincial/territorial TD1P Claim Amount associated with the specified province and TD1P claim code.

Parameters:
aProv - 2 character province/territory code: AB = Alberta BC = British Columbia MB = Manitoba NB = New Brunswick NL = Newfoundland/Labrador NT = Northwest Territories NS = Nova Scotia NU = Nunavut ON = Ontario PE = Prince Edward Island QC = Quebec SK = Saskatchewan YT = Yukon NA or OC = Cdn resident outside a province (e.g. Overseas military personnel) NR = Non-resident
claimCode - The TD1P claim code. Valid values: 0-10. Use claimCode = 1 to obtain the default Basic Provincial/Territorial Claim Amount.
Returns:
Integer value of the provincial/territorial TD1P Claim Amount rounded to the nearest penny. This value is expressed in whole cents - e.g. the value 9670.00 will be returned as 967000
Throws:
CptlException

getTD1PClaimRange

int getTD1PClaimRange(java.lang.String aProv,
                      int claimCode)
                      throws CptlException
getTD1PClaimRange(String aProv, int claimCode) returns the upper value of the provincial/territorial TD1P Claim Code range associated with the specified TD1P claim code.

Parameters:
claimCode - The TD1P claim code. Valid values: 0-10. Use claimCode = 1 to obtain the default Basic Provincial/Territorial Claim Amount.
Returns:
Integer value of the provincial/territorial TD1P Claim Amount rounded to the nearest penny. This value is expressed in whole cents - e.g. the value 9670.00 will be returned as 967000
Throws:
CptlException

getTD1PClaimCode

int getTD1PClaimCode(java.lang.String aProv,
                     int TD1P_ClaimAmount)
                     throws CptlException
getTD1PClaimCode(String aProv, int TD1P_ClaimAmount) feturns the provincial/territorial TD1P Claim Code associated with the specified TD1P claim amount.

Parameters:
aProv - 2 character province/territory code: AB = Alberta BC = British Columbia MB = Manitoba NB = New Brunswick NL = Newfoundland/Labrador NT = Northwest Territories NS = Nova Scotia NU = Nunavut ON = Ontario PE = Prince Edward Island QC = Quebec SK = Saskatchewan YT = Yukon NA or OC = Cdn resident outside a province (e.g. Overseas military personnel) NR = Non-resident
TD1P_ClaimAmount - The provincial/territorial TD1P claim amount rounded to the nearest whole penny Ð e.g. the value 9670.00 should be passed as 967000
Returns:
Integer value of the provincial/territorial TD1P Claim Code (0-10).
Throws:
CptlException

calcIndexedTD1PClaim

int calcIndexedTD1PClaim(java.lang.String aProv,
                         int TD1PBaseClaim,
                         int TD1PNoIndexAmount)
                         throws CptlException
calcIndexedTD1PClaim(String aProv, int TD1PBaseClaim, int TD1PNoIndexAmount) returns the current year's indexed provincial/territorial TD1P Claim Amount for the specified province (aProv), previous year TD1P total claim amount (TD1PBaseClaim) and non-indexable previous year TD1P claim amount (TD1PNoIndexAmount).

Parameters:
aProv - 2 character province/territory code: AB = Alberta BC = British Columbia MB = Manitoba NB = New Brunswick NL = Newfoundland/Labrador NT = Northwest Territories NS = Nova Scotia NU = Nunavut ON = Ontario PE = Prince Edward Island QC = Quebec SK = Saskatchewan YT = Yukon NA or OC = Cdn resident outside a province (e.g. Overseas military personnel) NR = Non-resident
TD1PBaseClaim - = previous year TD1P total claim amount.
TD1PNoIndexAmount - = previous year non-indexable portion of TD1P total claim amount.
Returns:
Integer value of the calculated indexed TD1P total claim amount for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException

getMaxCPP

int getMaxCPP()
              throws CptlException
getMaxCPP() returns an integer value equal to the maximum annual employee CPP deduction for the current taxation year.

Returns:
Integer value equal to the maximum annual employee CPP deduction for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException

getMaxCPPearnings

int getMaxCPPearnings()
                      throws CptlException
getMaxCPPearnings() returns an integer value equal to the maximum annual employee CPP pensionable earnings for the current taxation year.

Returns:
Integer value equal to the maximum annual employee CPP pensionable earnings for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException

getMaxEI

int getMaxEI(java.lang.String aProv)
             throws CptlException
getMaxEI(String aProv) returns an integer value equal to the maximum annual employee EI deduction for the current taxation year.

Parameters:
aProv - 2 character province/territory code: AB = Alberta BC = British Columbia MB = Manitoba NB = New Brunswick NL = Newfoundland/Labrador NT = Northwest Territories NS = Nova Scotia NU = Nunavut ON = Ontario PE = Prince Edward Island QC = Quebec SK = Saskatchewan YT = Yukon NA or OC = Cdn resident outside a province (e.g. Overseas military personnel) NR = Non-resident
Returns:
Integer value equal to the maximum annual employee EI deduction for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException

getMaxEIearnings

int getMaxEIearnings(java.lang.String aProv)
                     throws CptlException
getMaxEIearnings(String aProv) returns an integer value equal to the maximum annual employee EI insurable earnings for the current taxation year.

Parameters:
aProv - 2 character province/territory code: AB = Alberta BC = British Columbia MB = Manitoba NB = New Brunswick NL = Newfoundland/Labrador NT = Northwest Territories NS = Nova Scotia NU = Nunavut ON = Ontario PE = Prince Edward Island QC = Quebec SK = Saskatchewan YT = Yukon NA or OC = Cdn resident outside a province (e.g. Overseas military personnel) NR = Non-resident
Returns:
Integer value equal to the maximum annual employee EI insurable earnings for the current taxation year. This value is expressed in whole cents - e.g. value 100.00 will be returned as 10000
Throws:
CptlException