PayeeLeaveDetail Object

Manages the maintenance of a Payee Leave Year within a Payee Leave object.
Property Description
Accrued Double - total number of units of leave accrual for this leave type for this leave year
AccruedTo Variant date - date to which leave accrual has been calculated
Balance Double - total of leave accrual units minus the total of leave taken units for this leave year
Basis (NZ) Long - indicates the leave calculation method
Earnings (NZ) Currency - total of holiday pay earnings for all payee's leave years
Entitlement Double - leave entitlement for current year
HolidayPayDue(Payee, PayeeLeave) (NZ) Currency - calculates the amount of holiday pay due for the current leave year, taking into account the leave basis, earnings, leave entitlement, weeks worked and hours per week.
HolidayPayPaid (NZ) Currency - total of cash for leave taken pay items in the current leave year.
HoursWorked (NZ) Double - total of ordinary and overtime hours for all payee's leave years
Id Long - database identifier for this item (read only)
Index Long - subscript of this item within a PayeeLeaves collection
IsDeleted True/False - item has been flagged for deletion
IsDirty True/False - item has been modified but not saved yet
IsEditing True/false - item is in the process of being edited
IsNew True/false - item is new and has not been saved
IsValid True/false - indicates if the item has any errors
LeaveId Long - database record identifier for the payee leave object with which this leave detail is associated.
LeaveTypeId Long - database record identifier for the leave type of the payee leave object with which this leave detail is associated.
LeaveYear Variant date - the end date of the leave year.
PayeeId Long - database record identifier for this object's payee
Taken Double - total number of units of leave taken for this leave type for this payee
Units Long - indicates the type of units for leave accrual and taken (hours or days)
WeeksWorked (NZ) Double - total number of weeks worked for all payee's leave years. Note: it is the weeks of employment, less the number of whole weeks of sick leave taken.

In order to apply any changes to an object, the BeginEdit method must be called setting any property values. To save the changes, call the ApplyEdit method, and to undo the changes call the CancelEdit method.

Method Description
ApplyChildEdit Completes an edit session for the object.
ApplyEdit(Server, Connection) Saves the item in the database. Server is a string containing the name of the network server to provide the data, and Connection is the ADO connection string to establish a connection with the database on that server.
BeginChildEdit Prepares the item for updating.
CancelChildEdit Reverses the changes in the current edit session and restores the state of the item to that preceding the last BeginEdit.
Delete Flags the item for deletion. The item will be deleted from the database when the next ApplyEdit is called. A Delete must be preceded by a BeginEdit.
Load(Server, Connection, Country, PayeeId, LeaveTypeId) Loads into this object the data from the database for the specified database payee record id and leave type id. If Country is NZ, earnings totals for each leave year are accumulated.