PayrollPayStatementGenerationTask Class [AX 2012]
The PayrollPayStatementGenerationTask class initiates the payment process for the worker or group of workers that is specified by the calling payment process driver class.
| Method | Description | |
|---|---|---|
| allowSaveLast | (Inherited from RunBaseBatch.) |
| batchInfo | Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.) |
| calcBenefitsAndTaxes | Drives the process of generating tax and benefit lines for the pay statement. |
| calcGrossMinusTaxes | Calculates the net disposable earnings for the pay statement. |
| cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
| canGoBatch | Returns false (Inherited from RunBaseBatch.) |
| canGoBatchJournal | Determines whether the class is shown in the list of Journal types. (Inherited from RunBaseBatch.) |
| canSwapBetweenCS | Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.) |
| caption | Retrieves the description from the current class by calling the static description method of the class if there is one. (Inherited from RunBaseBatch.) |
| checkCloseDialog | Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.) |
| cleanupDialog | Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.) |
| createArrears | Determines whether the pay statement has enough earnings to cover all deductions, and if it does not, takes away deductive benefits and creates arrears until there are sufficient earnings for the pay statement. |
| createPayStatement | Creates the pay statement and associated line and distribution records for the specified worker. |
| deleteAccountingDistributionTemplate | Deletes the AccountingDistributionTemplate records that are used in the payment generation process. |
| dialog | Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from RunBase.) |
| dialogClear | Clears the contents of the dialog box. (Inherited from RunBase.) |
| dialogInit | Initializes the dialog box. (Inherited from RunBase.) |
| dialogInternal | (Inherited from RunBase.) |
| dialogMake | Obtains the dialog from a RunBase class. (Inherited from RunBase.) |
| dialogPost | Executes after the dialog method has been called. (Inherited from RunBaseBatch.) |
| dialogPostInit | Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.) |
| dialogPostRun | Called after the Dialog.run Method class. (Inherited from RunBase.) |
| dialogReInit | Reinitializes the dialog box. (Inherited from RunBase.) |
| dialogSelectCtrl | When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.) |
| dialogTask | When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.) |
| dialogUpdate | Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.) |
| dialogUpdateQuery | Updates the query in the dialog box. (Inherited from RunBase.) |
| doBatch | (Inherited from RunBaseBatch.) |
| equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
| getFromDialog | Assigns the dialog values to the internal variables. (Inherited from RunBaseBatch.) |
| getLast | Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.) |
| getRunBase | (Inherited from RunBase.) |
| getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
| handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
| handleArrears | Determines whether arrears have to be created, or whether arrear recovery should be tried. |
| inGetSaveLast | Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.) |
| init | Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.) |
| initBatch | (Inherited from RunBaseBatch.) |
| initializeFromPayment | Initializes the pay statement generation process to recalculate the existing PayrollPayStatement record with which it is supplied. |
| initParmDefault | Initializes the internal variables. (Inherited from RunBase.) |
| isInBatch | Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.) |
| isSwappingPrompt | Checks if the program is currently swapping from server to client. (Inherited from RunBase.) |
| lastValueDataAreaId | (Inherited from RunBase.) |
| lastValueDesignName | (Inherited from RunBase.) |
| lastValueElementName | (Inherited from RunBase.) |
| lastValueType | (Inherited from RunBase.) |
| lastValueUserId | (Inherited from RunBase.) |
| loadParameters | Drives the process of generating tax and benefit lines for the pay statement. |
| mustGoBatch | (Inherited from RunBaseBatch.) |
| mustLoadSaveQuery | Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.) |
| name | Returns the name of the RunBase class. (Inherited from RunBase.) |
| new | Initializes a new instance of the RunBaseBatch class. (Inherited from RunBaseBatch.) |
| notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
| notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
| objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
| owner | Returns the instance that owns the object. (Inherited from Object.) |
| pack | Serializes the current instance of the PayrollPayStatementGenerationTask class. (Overrides the pack Method.) |
| parmBatchNumber | Gets or sets the BatchNumber parameter. |
| parmBatchTaskGroupList | Gets or sets the BatchTaskGroupList parameter. |
| parmCurrentBatch | Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.) |
| parmDisableAccounting | Gets or sets the DisableAccounting parameter. |
| parmInBatch | Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.) |
| parmPaymentDate | Gets or sets the PaymentDate parameter. |
| parmPaymentType | Gets or sets the PaymentType parameter. |
| parmPayPeriodRecId | Gets or sets the PayPeriodRecId parameter. |
| parmProgress | Gets or sets the Progress parameter. (Inherited from RunBase.) |
| prepareForRecalc | Removes records that have to be recalculated by the payment process when the current payment is recalculated. |
| prepareForRun | Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.) |
| progressHide | Hides the Progress form. (Inherited from RunBase.) |
| progressInit | Initializes the Progress object in RunBase. (Inherited from RunBase.) |
| progressKill | Kills the Progress object in RunBase. (Inherited from RunBase.) |
| prompt | Displays the dialog from the class dialog and waits for user input. (Inherited from RunBaseBatch.) |
| promptPack | Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.) |
| promptUnpack | (Inherited from RunBaseBatch.) |
| putToDialog | Enables setting the fields that were just added in the RunBase.dialog Method method. This method is called from the RunBase.promptPrim Method method directly following the RunBase.dialogMake Method method. (Inherited from RunBase.) |
| queryRun | Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.) |
| recoverArrears | Determines whether any arrears can be recovered by the available earnings on the current pay statement, and if they can, they are recovered and benefit lines are created on the pay statement for the recovered amounts. |
| reset | Resets the class to its default state. (Inherited from RunBase.) |
| run | Contains the code that does the actual job of the class. (Overrides the run Method.) |
| runBase | Returns the RunBase itself. (Inherited from RunBase.) |
| runBaseDialogModifyType_RU | (Inherited from RunBase.) |
| runsImpersonated | Indicates whether the batch job will be run with the account of the user who created the job. (Inherited from RunBaseBatch.) |
| saveLast | Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.) |
| setDisableAccountingForRecalculation | Determines whether accounting is disabled for the pay statement. |
| setIsManualPayStatementGeneration | Determines whether the pay statement has just been created from the generation process and is for manual PayrollEarningStatementLine records. |
| setIsManualPayStatementRecalculation | Determines whether the pay statement has just been created from the generation process and is for manual PayrollEarningStatementLine records. |
| setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
| showBatchTab | (Inherited from RunBaseBatch.) |
| showClearButton | Determines whether to add a Clear button to the dialog box. If you change the return value to true it will add the button. (Inherited from RunBase.) |
| showDefaultButton | Determines whether a Default button is to be added to the dialog box. If you change the return value to true, it will add the button. (Inherited from RunBase.) |
| showDialog | (Inherited from RunBase.) |
| showIndexFields | If this method returns true, it will look for the first enabled index when you are adding query range fields to the dialog and if a data source does not have any ranges specified. It will also show the visible fields from that index. (Inherited from RunBase.) |
| showQuerySelectButton | (Inherited from RunBase.) |
| showQueryValues | Determines whether a Select button is to be added to the dialog box. If you change the return value to true, the button will be added. (Inherited from RunBase.) |
| toString | Returns a string that represents the current object. (Inherited from Object.) |
| unpack | Deserializes the packedClass parameter value to an instance of the PayrollPayStatementGenerationTask class. (Overrides the unpack Method.) |
| updatePayStatementTotals | Updates the net and gross totals on the pay statement. |
| usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
| validate | (Inherited from RunBaseBatch.) |
| validateEarnings | Validates the earnings for the pay statement. |
| validateFundsAvailableForTaxes | Validates that sufficient payable earnings (non-imputed) exist to cover all taxes for the payment. |
| validateWorker | Validates that the payment for the current worker will be able to continue without errors. |
| wait | Pauses a process. (Inherited from Object.) |
| xml | Returns an XML string that represents the current object. (Inherited from Object.) |
Community Additions
ADD
Show: