JmgValidateTimecard Class [AX 2012]

The JmgValidateTimecard class validates an employees electronic timecard registrations for a specific day when run through the JmgValidateTimecard::main method.

Syntax

class JmgValidateTimecard extends RunBase

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGoBatch	Returns false in this class. (Inherited from RunBase.)
	canSwapBetweenCS	Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
	caption	Returns the description from the current class by calling the static description method on the class if there is one. (Inherited from RunBase.)
	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.)
	dialog	Constructs the dialog, which prompts the user to determine whether registrations should be validated. (Overrides the dialog 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	Makes it possible to add controls after the main dialog method has been run because this method is called after the dialog method is called. (Inherited from RunBase.)
	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.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	error	Shows an error message to the user.
	getBreakTime	Returns the amount of break time defined in the profile between the specified start time and end time.
	getFromDialog	Assigns the dialog values to the internal variables. (Inherited from RunBase.)
	getLast	Gets the last choice that is stored in the last value table. (Inherited from RunBase.)
	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.)
	initParmDefault	Initializes the internal variables. (Inherited from RunBase.)
	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.)
	loadClockInOutZones	Returns an array of containers based on the employee electronic timecard registrations, each of which contains a clock-in - clock-out time pair, and an integer value always set to 0.
	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	Creates a new instance of the JmgValidateTimecard 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 JmgValidateTimecard class. (Overrides the pack Method.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmThrowError	Gets or sets the ThrowError parameter.
	prepareForRun	Allows subclasses to process the dialog box immediately before the dialog box.Run method. (Inherited from RunBase.)
	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	(Inherited from RunBase.)
	promptPack	Wraps a call to the RunBase.pack Method method when packing in the RunBase.promptPrim Method method. (Inherited from RunBase.)
	promptUnpack	Unpacks what the promptPack method has packed. (Inherited from RunBase.)
	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.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	run	Validates electronic timecard registrations referred to by the JmgValidateTimecard record, specified in the _args parameter of the JmgValidateTimecard.new method. (Overrides the run Method.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	saveLast	Saves the last choice by using the RunBase.pack Method method. (Inherited from RunBase.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	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 JmgValidateTimecard 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 the state of the internal variables. (Inherited from RunBase.)
	validateAbsence	Validates that entered absence registrations are placed outside of clock-in - clock-out zones.
	validatedOk	Retrieves whether the timecard is validated correctly.
	validateElapsedTime	Validates electronic timecard registrations using Elapsed time input mode.
	validateJobId	Validates the specified job ID. If the specified job ID is illegal, or if the employee is not allowed to register on the job ID, an error is thrown.
	validateNetTime	Validates electronic timecard registrations using Net time input mode. From and to time is updated on registrations. If the entered time on registrations cannot be placed within a clock-in - clock-out zone, an error is thrown.
	validateProj	Validates project timecard registrations.
	validateTimestamps	Validates electronic timecard registrations using Timestamp input mode. The time field is updated on registrations. If registrations are placed outside a clock-in - clock-out zone, or if a registrations from time is later than the to time, an error is thrown.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the JmgValidateTimecard class.
	::main	Provides an entry point for the JmgValidateTimecard class when it is called from a menu item.

Top

Remarks

The Args object to the main method must contain a reference to a JmgTimecardTable record. Otherwise an error is thrown. The following issues about an employees electronic timecard registrations is performed:

• Matching clock-in and clock-out registration

• Absence registrations are placed outside a clock-in - clock-out zone.

• It is possible to place entered job time within a clock-in - clock-out zone.

• Entered job IDs are valid.

When the electronic timecard form is configured to use input mode Elapsed time or Net time start and stop date/time is automatically calculated during validation.

Inheritance Hierarchy

Object Class
  RunBase Class
    JmgValidateTimecard Class

See Also

JmgTimecardTable Table