PayrollCalculatePayStatementBenefits Class [AX 2012]

The PayrollCalculatePayStatementBenefits class performs the logic for calculating and creating the applicable PayrollPayStatementBenefitLine records for a pay statement.

class PayrollCalculatePayStatementBenefits

Run On

Server

  MethodDescription
JJ740843.protmethod(en-us,AX.60).gif applyContributionLimits Applies the contribution limits.
JJ740843.privmethod(en-us,AX.60).gif applyContributionLimitsEmployeeLimit
JJ740843.privmethod(en-us,AX.60).gif applyContributionLimitsFixed
JJ740843.protmethod(en-us,AX.60).gif applyDeductionLimits Applies deduction limits.
JJ740843.protmethod(en-us,AX.60).gif applyGarnishmentLimit Applies garnishment limits.
JJ740843.protmethod(en-us,AX.60).gif calculateBaseContributionAmount Calculates the base contribution amount of the benefit.
JJ740843.protmethod(en-us,AX.60).gif calculateBaseContributionAmountCascading Calculates the base contribution amount according to the specified earning basis for retirement benefits that have cascading tiers.
JJ740843.protmethod(en-us,AX.60).gif calculateBaseDeductionAmount Calculates the base deduction amount for all payroll categories.
JJ740843.pubmethod(en-us,AX.60).gif calculateBenefits Performs the main processing loop for calculating and creating PayrollPayStatementBenefitLine records.
JJ740843.protmethod(en-us,AX.60).gif calculateDisposableIncome Determines the amount of disposable income.
JJ740843.protmethod(en-us,AX.60).gif calculateEarningBasis Calculates the earning basis amount for contributions or deductions.
JJ740843.protmethod(en-us,AX.60).gif calculateGarnishmentDeduction Determines the actual deduction amount for each garnishment or tax levy benefit.
JJ740843.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif createBenefitLine Creates the benefit line.
JJ740843.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
JJ740843.protmethod(en-us,AX.60).gif getRetirementLimitForBenefit Retrieves the annual limit amount for the current benefit that is being processed.
JJ740843.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
JJ740843.privmethod(en-us,AX.60).gif initializeBenefitCalculations Initializes the variables that are specific to each benefit that is being processed.
JJ740843.pubmethod(en-us,AX.60).gif initializeForPayment Initializes the class in preparation for processing of the benefits that are related to the PayrollPayStatement table record.
JJ740843.pubmethod(en-us,AX.60).gif new Initializes a new instance of the PayrollCalculatePayStatementBenefits class.
JJ740843.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif processGarnishment Processes all qualified garnishment benefits.
JJ740843.protmethod(en-us,AX.60).gif reachedAnnualRetirementDeductionLimit Determines whether the benefit retirement group for the retirement benefit has already reached the annual deduction limit, as determined by the Symmetry Tax Engine.
JJ740843.protmethod(en-us,AX.60).gif reachedAnnualWageLimit Determines whether the benefit retirement group for the retirement benefit has already reached the annual wage limit, as determined by the Symmetry Tax Engine.
JJ740843.protmethod(en-us,AX.60).gif reachedTotalRetirementLimit Determines whether the benefit retirement group for the retirement benefit has already reached the total limit, as determined by the Symmetry Tax Engine.
JJ740843.protmethod(en-us,AX.60).gif retrieveContributionBenefitRates Retrieves the benefit rate that should be used when the contribution amount is calculated.
JJ740843.protmethod(en-us,AX.60).gif retrieveSymmetryBenefitLimits Retrieves the applicable limit types from the tax engine that is used by the process when the limits of benefits are checked.
JJ740843.protmethod(en-us,AX.60).gif setAllHoursQuery Builds the logic for calculating the earning basis for the all hours earning method.
JJ740843.protmethod(en-us,AX.60).gif setAnnualWageLimits Determines the annual wage limits.
JJ740843.protmethod(en-us,AX.60).gif setCalendarYearRetirementDeductionLimits Determines the deduction limit amount for the two retirement benefit groupings.
JJ740843.protmethod(en-us,AX.60).gif setDeductionLimit Determine the maximum deduction amount that is allowed for garnishment or tax levy benefits.
JJ740843.protmethod(en-us,AX.60).gif setPercentOfEarningsQuery Builds the logic for calculating the earning basis for the percent of earnings earning method.
JJ740843.protmethod(en-us,AX.60).gif setProductiveHoursQuery Builds the logic for calculating the earning basis for the productive hours earning method.
JJ740843.protmethod(en-us,AX.60).gif setRegularEarningsQuery Builds the logic for calculating the earning basis for the regular earnings earning method.
JJ740843.protmethod(en-us,AX.60).gif setRegularHoursQuery Builds the logic for calculating the earning basis for the regular hours earning method.
JJ740843.protmethod(en-us,AX.60).gif setRegularPortionOfAllPayQuery Builds the logic for calculating the earning basis for the regular portion of all pay earning method.
JJ740843.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
JJ740843.protmethod(en-us,AX.60).gif setTotalHoursQuery Builds the logic for calculating the earning basis for the total hours earning method.
JJ740843.protmethod(en-us,AX.60).gif setTotalLimitsForRetirementBenefits Retrieves the total limit amounts and current totals for the two retirement benefit groupings, 401K/403 and 457.
JJ740843.protmethod(en-us,AX.60).gif setupContributionEarningBasisQuery Builds the contribution earning basis query to determine the earning basis amount, based on the contribution basis of the benefit.
JJ740843.protmethod(en-us,AX.60).gif setupDeductionEarningBasisQuery Contains the main logic for calculating the deduction earning basis amount.
JJ740843.protmethod(en-us,AX.60).gif setupEarningsBasisInitialQuery Builds the base query that is used to calculate the earning basis amount.
JJ740843.protmethod(en-us,AX.60).gif setYtdContributionAmountForBenefit Performs the logic for calculating and applying the limits that are related to retirement.
JJ740843.protmethod(en-us,AX.60).gif setYtdDeductionAmountForRetirementTypes Sets the currentYtdDeductionAmount variable, based on the sum of benefits for all retirement types.
JJ740843.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
JJ740843.pubmethod(en-us,AX.60).gif JJ740843.static(en-us,AX.60).gif ::getBenefitTotalQueryByDateRange Calculates the base deduction amount for all payroll categories.
JJ740843.protmethod(en-us,AX.60).gif JJ740843.static(en-us,AX.60).gif ::isContributionBasisAmountBased Determines whether the PayrollContributionBasis enum value is amount-based or quantity-based.
JJ740843.protmethod(en-us,AX.60).gif JJ740843.static(en-us,AX.60).gif ::isDeductionBasisAmountBased Determines whether the PayrollDeductionBasis enum value is amount-based or quantity-based.
Top

This class is consumed by the PayrollPayStatementGenerationTask class to calculate the benefits part of the pay statement.

Object Class
  PayrollCalculatePayStatementBenefits Class

Community Additions

ADD
Show: