Share via


HcmBenefit::findByTimeState Method

Finds a record in the HcmBenefit table by using the specified record ID.

Syntax

client server public static HcmBenefit findByTimeState(
    HcmBenefitRecId _recId, 
   [utcdatetime _validFrom, 
    utcdatetime _validTo, 
    boolean _forUpdate, 
    ConcurrencyModel _concurrencyModel])

Run On

Called

Parameters

  • _validFrom
    Type: utcdatetime
    A ValidFrom field value; optional.
  • _validTo
    Type: utcdatetime
    A ValidTo field value; optional.
  • _forUpdate
    Type: boolean
    A Boolean value that specifies whether to read the record for update; optional.

Return Value

Type: HcmBenefit Table
A record from the HcmBenefit table, see remarks.

Remarks

Values for the _validFrom and _validTo parameters limit the table selection in the following way.

  1. If no values are supplied for both of the parameters, they are set to their default values. Therefore, the method searches for only active records and returns either an empty record or a valid record.

  2. If only the first parameter value is supplied, the second parameter uses the value of the first parameter. The method searches for active records as of the supplied datetime value and returns either an empty or a valid record.

  3. If both parameters are supplied with values, the method searches for records that have ValidFrom and ValidTo values fall in that interval. The method returns either an empty or a valid record.

See Also

Reference

HcmBenefit Table