JmgTimecardChangeEmployee Class [AX 2012]

The JmgTimecardChangeEmployee table lists the variables in the class declaration, and their type and a short description.

class JmgTimecardChangeEmployee extends RunBase

Run On

Called

  MethodDescription
Gg743706.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif canGoBatch Returns false in this class. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif canSwapBetweenCS Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif caption Returns the description from the current class by calling the static description method on the class if there is one. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif checkCloseDialog Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
Gg743706.privmethod(en-us,AX.60).gif checkPinCode Checks whether the user has entered the correct pin code.
Gg743706.privmethod(en-us,AX.60).gif checkWorker Checks whether the worker entered by the user is valid.
Gg743706.protmethod(en-us,AX.60).gif cleanupDialog Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif dialog Retrieves a class that contains the methods described by the RunBaseDialogable interface. (Overrides the dialog Method.)
Gg743706.pubmethod(en-us,AX.60).gif dialogClear Clears the contents of the dialog box. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogInit Initializes the dialog box. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif dialogInternal (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogMake Obtains the dialog from a RunBase class. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif 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.)
Gg743706.protmethod(en-us,AX.60).gif dialogPostInit Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogPostRun Called after the Dialog.run Method class. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif dialogReInit Reinitializes the dialog box. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogSelectCtrl When using the dialog class for dialog, this method is called whenever a control is selected. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogTask When using the Dialog Class class for dialog, this method is called from the task method in the dialog form. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogUpdate Updates the dialog, for example after reinitializing the query. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif dialogUpdateQuery Updates the query in the dialog box. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif getFromDialog Assigns the dialog values to the emplId and pinCode variables after the dialog is closed. (Overrides the getFromDialog Method.)
Gg743706.pubmethod(en-us,AX.60).gif getLast Gets the last choice that is stored in the last value table. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif getRunBase (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg743706.protmethod(en-us,AX.60).gif inGetSaveLast Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif init Gives RunBase the same profile as, for example, a FormRun class. This method is not used in the standard application. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif initParmDefault Initializes the internal variables. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif isSwappingPrompt Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif lastValueDataAreaId (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif lastValueDesignName (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif lastValueElementName (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif lastValueType (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif lastValueUserId (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif mustLoadSaveQuery Determines whether the last query must be loaded and saved when you leave the form. Called from the SysQueryForm. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif name Returns the name of the RunBase class. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif new Creates a new instance of the JmgTimecardChangeEmployee class. (Overrides the new Method.)
Gg743706.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif pack Serializes the current instance of the JmgTimecardChangeEmployee class. (Overrides the pack Method.)
Gg743706.pubmethod(en-us,AX.60).gif parmProgress Gets or sets the Progress parameter. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif prepareForRun Allows subclasses to process the dialog box immediately before the dialog box.Run method. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif progressHide Hides the Progress form. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif progressInit Initializes the Progress object in RunBase. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif progressKill Kills the Progress object in RunBase. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif prompt (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif promptPack Wraps a call to the RunBase.pack Method method when packing in the RunBase.promptPrim Method method. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif promptUnpack Unpacks what the promptPack method has packed. (Inherited from RunBase.)
Gg743706.protmethod(en-us,AX.60).gif 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.)
Gg743706.pubmethod(en-us,AX.60).gif queryRun Returns the QueryRun object, which is used by the QueryPrompt class. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif reset Resets the class to its default state. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif run Updates the Args object specified in the JmgTimecardChangeEmployee.new method is updated. (Overrides the run Method.)
Gg743706.pubmethod(en-us,AX.60).gif runBase Returns the RunBase itself. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif runBaseDialogModifyType_RU (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif saveLast Saves the last choice by using the RunBase.pack Method method. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg743706.protmethod(en-us,AX.60).gif 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.)
Gg743706.pubmethod(en-us,AX.60).gif 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.)
Gg743706.pubmethod(en-us,AX.60).gif showDialog (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif 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.)
Gg743706.pubmethod(en-us,AX.60).gif showQuerySelectButton (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif 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.)
Gg743706.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif unpack Deserializes the packedClass parameter value to an instance of the JmgTimecardChangeEmployee class. (Overrides the unpack Method.)
Gg743706.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif validate Validates the state of the internal variables. (Inherited from RunBase.)
Gg743706.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg743706.privmethod(en-us,AX.60).gif workerLookup Shows a worker lookup form for the specified FormReferenceGroupControl class.
Gg743706.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)
Gg743706.pubmethod(en-us,AX.60).gif Gg743706.static(en-us,AX.60).gif ::main Provides an entry point for the JmgTimecardChangeEmployee class when it is called from a menu item.
Top

worker

JmgWorkerRecId

The worker entered by the user.

pinCode

JmgPINCode

The pin code entered by the user.

dfWorker

DialogField

Reference to the worker dialog field.

dfPinCode

DialogField

Reference to the pinCode dialog field.

profileDate

JmgProfileDate

The profile date for which the user is trying to use the electronic timecard.

caller

FormRun

Reference to the FormRun object.

The following macros are defined in the class declaration:

CurrentVersion

The current version of the CurrentList macro.

CurrentList

The list of variables that is packed and unpacked by the pack and unpack methods.

This class is used in connection with the JmgTimecard form. The class is run when the Change employee button is clicked on the form. The user is prompted for an employee ID, and if the shop floor control parameters requires it, a password. When the user clicks OK, it is validated, that the employee is allowed to use the electronic timecard, and that the entered password is correct.

If the class is not run with a reference to a FormRun object in the JmgTimecard form, an error is thrown. When the invocation is complete, the _args object is updated. The _args.parmEnum field returns:

  • NoYes::Yes if the user entered a valid employee ID, and, if required, a valid pin code. The _args.parm method will contain the entered employee ID.

  • NoYes::No if the user clicked the cancel button.

The following example prompts the user to change the employee on the timecard form.

// Prompt user to change employee in timecard form. 
public void changeEmployee(FormRun _timecardForm) 
{ 
    Args a; 
 
    a = new Args(); 
    a.caller(_timecardForm); 
  
    JmgTimecardChangeEmployee::main(a); 
  
    if (a.parmEnum() == NoYes::Yes) 
    { 
        info("User entered employee id: " + a.parm()); 
    } 
    else 
    { 
        info("User clicked cancel"); 
    } 
}

Object Class
  RunBase Class
    JmgTimecardChangeEmployee Class

Community Additions

ADD
Show: