Share via


RunBaseReport Class [AX 2012]

The RunBaseReport class makes all reports batchable and creates a standard dialog box.

Syntax

class RunBaseReport extends RunBaseBatch

Run On

Called

Methods

  Method Description
Gg823053.pubmethod(en-us,AX.60).gif allowSaveLast (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif batchInfo Returns the BatchInfo class. This class is the API for the batch table. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif canGoBatch Returns false. (Overrides the canGoBatch Method.)
Gg823053.protmethod(en-us,AX.60).gif canGoBatchJournal Determines whether the class is shown in the list of Journal types. (Inherited from RunBaseBatch.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif caption Returns the description from the current class. (Overrides the caption Method.)
Gg823053.pubmethod(en-us,AX.60).gif checkCloseDialog Must be called in the CloseOk method of a RunBase dialog box. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif cleanupDialog Provides a way to clean up after a dialog box has been canceled. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif dialog Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
Gg823053.pubmethod(en-us,AX.60).gif dialogClear Clears the contents of the dialog box. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif dialogInit Initializes the dialog box. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif dialogInternal (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif dialogMake Obtains the dialog from a RunBase class. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif dialogPost Executes after the dialog method has been called. (Inherited from RunBaseBatch.)
Gg823053.protmethod(en-us,AX.60).gif dialogPostInit Called right after the RunBase.dialogInit Method method. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif dialogPostRun Called after the Dialog.run Method class. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif dialogReInit Reinitializes the dialog box. (Inherited from RunBase.)
Gg823053.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.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif dialogUpdate Updates the dialog, for example after reinitializing the query. (Overrides the dialogUpdate Method.)
Gg823053.pubmethod(en-us,AX.60).gif dialogUpdatePrinterSettings
Gg823053.pubmethod(en-us,AX.60).gif dialogUpdateQuery Updates the query in the dialog box. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif doBatch (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif doNotOverwriteOnBatch
Gg823053.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif getFromDialog Assigns the dialog values to the internal variables. (Overrides the getFromDialog Method.)
Gg823053.pubmethod(en-us,AX.60).gif getLast Gets the last choice stored in the last value table. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif getRunBase (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg823053.protmethod(en-us,AX.60).gif inGetSaveLast Returns true when the GetLast or SaveLast method is executed. (Inherited from RunBase.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif initBatch (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif initParmDefault Initializes the internal variables. (Overrides the initParmDefault Method.)
Gg823053.protmethod(en-us,AX.60).gif initQuery Initializes the query that is used in the report.
Gg823053.protmethod(en-us,AX.60).gif initQueryRun Initializes the internal queryRun variable.
Gg823053.pubmethod(en-us,AX.60).gif initReportRun Puts a SysReportRun class into the RunBaseReport class.
Gg823053.pubmethod(en-us,AX.60).gif initWebParm
Gg823053.pubmethod(en-us,AX.60).gif isInBatch Determines whether the RunBaseBatch is actually being run from a batch server. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif isSwappingPrompt Checks if the program is currently swapping from server to client. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif lastValueDataAreaId (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif lastValueDesignName (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif lastValueElementName Returns the name of the report in the Application Object Tree (AOT) that will be used. (Overrides the lastValueElementName Method.)
Gg823053.pubmethod(en-us,AX.60).gif lastValueType (Overrides the lastValueType Method.)
Gg823053.pubmethod(en-us,AX.60).gif lastValueUserId (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif makePrintJobSettings
Gg823053.pubmethod(en-us,AX.60).gif makeQueryRun
Gg823053.pubmethod(en-us,AX.60).gif makeReportRun
Gg823053.pubmethod(en-us,AX.60).gif mustGoBatch (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif mustLoadSaveQuery Determines whether the last query must be loaded and saved when you leave the form. Called from SysQueryForm class. (Overrides the mustLoadSaveQuery Method.)
Gg823053.pubmethod(en-us,AX.60).gif name Returns the name of the RunBase class. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif new Initializes a new instance of the RunBaseBatch class. (Inherited from RunBaseBatch.)
Gg823053.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.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif pack Serializes the current instance of the RunBaseReport class. (Overrides the pack Method.)
Gg823053.pubmethod(en-us,AX.60).gif parmCurrentBatch Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif parmInBatch Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif parmProgress Gets or sets the Progress parameter. (Inherited from RunBase.)
Gg823053.protmethod(en-us,AX.60).gif prepareForRun Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif printJobSettings
Gg823053.pubmethod(en-us,AX.60).gif progressHide Hides the Progress form. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif progressInit Initializes the Progress object in RunBase. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif progressKill Kills the Progress object in RunBase. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif prompt Displays the dialog from the class dialog and waits for user input. (Overrides the prompt Method.)
Gg823053.protmethod(en-us,AX.60).gif promptPack Wraps a call to the RunBase.pack Method when packing in the RunBase.promptPrim Method. (Inherited from RunBaseBatch.)
Gg823053.protmethod(en-us,AX.60).gif promptUnpack (Inherited from RunBaseBatch.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif queryNextUniqueId
Gg823053.pubmethod(en-us,AX.60).gif queryRun Retrieves the instance of the QueryRun class, which is used by the queryPrompt method. (Overrides the queryRun Method.)
Gg823053.pubmethod(en-us,AX.60).gif reportAutoDesignSpecs
Gg823053.pubmethod(en-us,AX.60).gif reportDesign
Gg823053.pubmethod(en-us,AX.60).gif reportRun
Gg823053.pubmethod(en-us,AX.60).gif reset Resets the class to its default state. (Overrides the reset Method.)
Gg823053.pubmethod(en-us,AX.60).gif resetQueryRun
Gg823053.pubmethod(en-us,AX.60).gif run Contains the code that does the actual job of the class. (Overrides the run Method.)
Gg823053.pubmethod(en-us,AX.60).gif runBase Returns the RunBase itself. (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif runBaseDialogModifyType_RU (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif runsImpersonated Indicates whether the batch job will be run with the account of the user who created the job. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif runWebReport
Gg823053.pubmethod(en-us,AX.60).gif saveLast Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif setDesign
Gg823053.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif showAsGraph
Gg823053.pubmethod(en-us,AX.60).gif showBatchTab (Inherited from RunBaseBatch.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif showDefaultButton Determines whether to add a Default button to the dialog. If you change the return value to true, it will add the button. (Overrides the showDefaultButton Method.)
Gg823053.pubmethod(en-us,AX.60).gif showDialog (Inherited from RunBase.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif showPrinterSelect
Gg823053.pubmethod(en-us,AX.60).gif showQuerySelectButton (Inherited from RunBase.)
Gg823053.pubmethod(en-us,AX.60).gif showQueryValues Determines whether to add a Select button to the dialog. (Overrides the showQueryValues Method.)
Gg823053.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif unpack Deserializes the packedClass parameter value to an instance of the RunBaseReport class. (Overrides the unpack Method.)
Gg823053.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.)
Gg823053.pubmethod(en-us,AX.60).gif validate (Inherited from RunBaseBatch.)
Gg823053.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg823053.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is instantiated through the SysReportRun Class. It should be used by all reports. The purpose of the class is to:

  • Make all reports batchable

  • Create a standard dialog

If you are creating more complex reports, it might be necessary to inherit from this class. If this is the case, you must create the following methods:

  • lastValueElementName(). Returns the report name.

  • description(). Static.

  • main(). Static.

Note

The corresponding menu item must use the class rather than the report. If you can avoid it, do not create a class and inherit from this class. Try to solve the report in the actual report.

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      RunBaseReport Class
        MCRCustReport_BaseData Class
        MCRDropShipPurchOrder Class
        PmfCoByProdReport_CalcTrans Class
        RunbaseReportStd Class

See Also

RunbaseReportStd Class

RunBaseBatch Class