HcmBenefit::lookupEarningStatHcmBenefit Method

Provides a custom lookup for the HcmBenefit records that filters on the basis of date, Worker, category and legal entity.

Syntax

client server public static Common lookupEarningStatHcmBenefit(
    FormReferenceControl _formReferenceControl, 
   [utcdatetime _dateToFilter, 
    HcmWorkerRecId _workerRecId, 
    PayrollCategory _payrollCategory, 
    LegalEntityRecId _legalEntity, 
    HcmBenefitPlanId _benefitPlanID, 
    HcmBenefitOptionId _benefitOptionID])

Run On

Called

Parameters

• _formReferenceControl
  Type: FormReferenceControl Class
  The form control that is bound to the foreign key reference to the PayrollEarningCode table.

• _dateToFilter
  Type: utcdatetime
  The date to filter.

• _workerRecId
  Type: HcmWorkerRecId Extended Data Type
  The worker record Id.

• _payrollCategory
  Type: PayrollCategory Enumeration
  The payroll category that is associated with the benefit.

• _legalEntity
  Type: LegalEntityRecId Extended Data Type
  The legal entity record.

• _benefitPlanID
  Type: HcmBenefitPlanId Extended Data Type
  The HcmBenefitPlan record ID.

• _benefitOptionID
  Type: HcmBenefitOptionId Extended Data Type
  The HcmBenefitOption record ID.

Return Value

Type: Common Table
A reference to a HcmBenefit record.

Remarks

This method is necessary only because the filter-by-grid functionality does not lock down the meta-data specified fixed field relationship values, so they are repeated here.

See Also

Reference

HcmBenefit Table