HcmPosition::getPositionStatus Method
Retrieves the status of a HcmPosition record at a specified point in time by using the position duration of the record.
Syntax
client server public static HcmPositionStatus getPositionStatus(HcmPositionRecId _positionRecId, [utcdatetime _asOfDate])
Run On
Called
Parameters
- _positionRecId
Type: HcmPositionRecId Extended Data Type
A record ID that represents the HcmPosition record for which to retrieve the current status.
- _asOfDate
Type: utcdatetime
The point in time to use for the selection criteria.
Return Value
Type: HcmPositionStatus Enumeration
The HcmPositionStatus enumeration value for the HcmPosition record at the specified point in time.
Remarks
If the _asOfDate parameter is between the activation and expiration dates it has an HcmPositionStatus::Active enumeration value. If the _asOfDate parameter is earlier than the activation date of the position it has an HcmPositionStatus::Inactive enumeration value. If the _asOfDate parameter is after the retirement date of the position it has an HcmPositionStatus::Retired enumeration value.