PayrollEarningStatementGeneration Class [AX 2012]

The PayrollEarningStatementGeneration class is a wrapper class around the PayrollEarningStatementGenerationTask class to provide a dialog box to create recurring earnings and salary earnings.

Syntax

class PayrollEarningStatementGeneration extends PayrollStatementGeneration

Run On

Called

Methods

	Method	Description
	allowSaveLast	Saves the last user selection on the query if the process is not called from a worker or position form. (Inherited from PayrollStatementGeneration.)
	batchInfo	Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Returns false. (Inherited from PayrollStatementGeneration.)
	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.)
	companyEndOfPayPeriodAdjusted	Retrieves the period end date and time, removing the company's time zone offset. (Inherited from PayrollStatementGeneration.)
	createPeriodList	Builds the list of period start and end dates, and populates the combo box in the dialog box with these values for the process. (Inherited from PayrollStatementGeneration.)
	dialog	Constructs the pay cycle and pay period controls in the dialog box. (Inherited from PayrollStatementGeneration.)
	dialogCaption	Sets the caption for the dialog box.The earning process and payment process set different captions for the dialog box. (Overrides the dialogCaption Method.)
	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	Gets the input from the dialog box that contains the user selection for the process. (Inherited from PayrollStatementGeneration.)
	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	Gets the pay cycle and pay period from the dialog box, and modifies the query according to the user selections. (Inherited from PayrollStatementGeneration.)
	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.)
	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.)
	initializeTask	Constructs the PayrollEarningGenerationTask class for earning processing. (Overrides the initializeTask Method.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	initQuery	Initializes the QueryRun object by using the PayrollStatementGenerationQuery query. (Inherited from PayrollStatementGeneration.)
	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.)
	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 PayrollEarningStatementGeneration class. (Overrides the new Method.)
	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 PayrollEarningStatementGeneration class. (Overrides the pack Method.)
	parmCallingRecord	Gets or sets the CallingRecord parameter.
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	parmPayPeriodRecId	Gets or sets the PayPeriodRecId parameter.
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmSkipCompletionMsgDisplay	Gets or sets the SkipCompletionMsgDisplay parameter.
	payCycleControl_modified	Rebuilds the list of period end dates whenever the pay cycle changes. (Inherited from PayrollStatementGeneration.)
	payCycleHelpText	Sets the help text for the pay cycle control.The earning process and payment process set different help texts. (Overrides the payCycleHelpText Method.)
	payPeriodHelpText	Sets the help text for the pay period control.The earning process and payment process set different help texts. (Overrides the payPeriodHelpText Method.)
	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 PayrollStatementGeneration.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	run	Schedules the actual document generation process for the workers who hold valid positions that are paid by the current legal entity, and for the selected pay cycle. (Inherited from PayrollStatementGeneration.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runScheduleJob	Schedules the document process for running in the context of a batch job or running without a batch. (Overrides the runScheduleJob Method.)
	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.)
	setRange	Modifies the JoinType value in the query on the HcmPositionUnionAgreement table to OuterJoin when no union agreement is specified because it is not mandatory, and adds a specific worker or position range if it is called from the worker or position detail form. (Inherited from PayrollStatementGeneration.)
	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 added to the dialog box. (Inherited from PayrollStatementGeneration.)
	showStatementCountMessage	Shows the information related to the number of statements that were created or updated by the process. (Overrides the showStatementCountMessage Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedClass parameter value to an instance of the PayrollEarningStatementGeneration class. (Overrides the unpack Method.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validate	Validates whether both the pay cycle and pay period controls in the dialog box have values before the processing starts. (Inherited from PayrollStatementGeneration.)
	validateCallingPosition	Determines whether the calling position is valid. (Overrides the validateCallingPosition Method.)
	validateCallingWorker	Determines whether the calling worker is valid. (Overrides the validateCallingWorker Method.)
	validatePayrollPositionDetail
	validateProcess	Performs validations that are specific to the overall generation process. (Inherited from PayrollStatementGeneration.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Constructs an instance of the process class on the server.
	::main	Provides an entry point for the PayrollEarningStatementGeneration class when it is called from a menu item.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      PayrollStatementGeneration Class
        PayrollEarningStatementGeneration Class
          PayrollEarningStatementGenerationNoBatch Class