PayrollWorkerGarnishment::findByTimeState Method

Finds a record in the PayrollWorkerGarnishment table, based on the record ID.

Syntax

client server public static PayrollWorkerGarnishment findByTimeState(
    PayrollWorkerGarnishmentRecId _recId, 
   [ValidFromDate _validFrom, 
    ValidToDate _validTo, 
    boolean _forUpdate, 
    ConcurrencyModel _concurrencyModel])

Run On

Called

Parameters

• _recId
  Type: PayrollWorkerGarnishmentRecId Extended Data Type
  The record ID to find.

• _validFrom
  Type: ValidFromDate Extended Data Type
  A ValidFrom field value.

• _validTo
  Type: ValidToDate Extended Data Type
  A ValidTo field value.

• _forUpdate
  Type: boolean
  A Boolean value that specifies whether to read the record for update; optional.

• _concurrencyModel
  Type: ConcurrencyModel Enumeration
  An enumeration value that indicates whether a concurrency setting should be used on the table; optional.

Return Value

Type: PayrollWorkerGarnishment Table
A record from the PayrollWorkerGarnishment table. See the remarks.

Remarks

Values for the _validFrom and _validTo parameters limit the table selection in the following ways:

1. If no value is supplied for either parameter, the current date/time is used for both by default. Therefore, the method searches for active records only, and returns either an empty record or a valid record.

2. If a value is supplied for only the first parameter, the same value is used for the second parameter by default. The method searches for active records as of the supplied date/time value, and returns either an empty record or a valid record.

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

Use the isActiveByTimeState API to check for the existence of a record.

This method tries to get the record and is an expensive operation.

See Also

Reference

PayrollWorkerGarnishment Table