PayrollWorkerEnrolledBenefitLimit::adjustBenefitLimitAmount Method

Manages the benefit limit remaining amount for the given worker benefit by the amount specified.

Syntax

client server public static void adjustBenefitLimitAmount(
    Amount _adjustmentAmount, 
    HcmWorkerEnrolledBenefitRecId _workerEnrolledBenefit, 
    boolean _isEmployer, 
    PayrollPayPeriod _payPeriod, 
   [boolean _displayMessage])

Run On

Called

Parameters

• _adjustmentAmount
  Type: Amount Extended Data Type
  The amount by which to adjust the benefit.

• _workerEnrolledBenefit
  Type: HcmWorkerEnrolledBenefitRecId Extended Data Type
  The HcmWorkerEnrolledBenefit used to access and update the benefit limit remaining.

• _isEmployer
  Type: boolean
  Indicates if the amount to adjust is for a benefit deduction or contribution.

• _payPeriod
  Type: PayrollPayPeriod Table
  The pay period value to use for processing the limit period.

• _displayMessage
  Type: boolean
  Specifies whether the warning message should be displayed if the limit has been exceeded.

Remarks

A negative _adjustmentAmount parameter indicates a benefit line was added or increased whereas a positive amount indicates a benefit line was removed or reduced.

See Also

Reference

PayrollWorkerEnrolledBenefitLimit Table