RunbaseReportStd Class [AX 2012]

The RunbaseReportStd class enables making all reports batchable and creating a standard dialog box.

Syntax

class RunbaseReportStd extends RunBaseReport

Run On

Called

Methods

	Method	Description
	allowSaveLast	(Overrides the allowSaveLast Method.)
	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. (Overrides the canGoBatch Method.)
	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	Returns the description from the current class. (Overrides the caption Method.)
	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	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
	dialogCaption
	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. (Overrides the dialogMake Method.)
	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. (Overrides the dialogSelectCtrl Method.)
	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 RunBaseReport.)
	dialogUpdatePrinterSettings	(Overrides the dialogUpdatePrinterSettings Method.)
	dialogUpdateQuery	Updates the query in the dialog box. (Inherited from RunBase.)
	doBatch	(Inherited from RunBaseBatch.)
	doNotOverwriteOnBatch	(Inherited from RunBaseReport.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getFromDialog	Assigns the dialog values to the internal variables. (Overrides the getFromDialog Method.)
	getLast	Gets the last choice stored in the last value table. (Overrides the getLast Method.)
	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.)
	hideBatchTab
	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.)
	initFromCaller
	initParmDefault	Initializes the internal variables. (Overrides the initParmDefault Method.)
	initQuery	Initializes the query that is used in the report. (Overrides the initQuery Method.)
	initQueryRun	Initializes the internal queryRun variable. (Overrides the initQueryRun Method.)
	initReportRun	Puts a SysReportRun class into the RunBaseReport class. (Overrides the initReportRun Method.)
	initWebParm	(Overrides the initWebParm Method.)
	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	(Overrides the lastValueDesignName Method.)
	lastValueElementName	Returns the name of the report in the Application Object Tree (AOT) that will be used. (Overrides the lastValueElementName Method.)
	lastValueType	(Inherited from RunBaseReport.)
	lastValueUserId	(Inherited from RunBase.)
	makePrintJobSettings	(Inherited from RunBaseReport.)
	makeQueryRun	(Inherited from RunBaseReport.)
	makeReportRun	(Inherited from RunBaseReport.)
	mustGoBatch	(Inherited from RunBaseBatch.)
	mustLoadSaveQuery	Determines whether the last query must be loaded and saved when you leave the form. (Overrides the mustLoadSaveQuery Method.)
	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 RunbaseReportStd class. (Overrides the pack Method.)
	parmCurrentBatch	Gets or sets the CurrentBatch parameter. (Inherited from RunBaseBatch.)
	parmInBatch	Gets or sets the InBatch parameter. (Inherited from RunBaseBatch.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmReportName	Gets or sets the ReportName parameter.
	prepareForRun	Allows subclasses to process the dialog box immediately before the execution of the dialog box.Run method. (Inherited from RunBaseBatch.)
	printJobSettings	(Inherited from RunBaseReport.)
	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 RunBaseReport.)
	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.)
	queryNextUniqueId	(Inherited from RunBaseReport.)
	queryRun	Retrieves the instance of the QueryRun class, which is used by the queryPrompt method. (Inherited from RunBaseReport.)
	reportAutoDesignSpecs	(Inherited from RunBaseReport.)
	reportDesign	(Inherited from RunBaseReport.)
	reportIsRunOnServer
	reportRun	(Inherited from RunBaseReport.)
	reset	Resets the class to its default state. (Inherited from RunBaseReport.)
	resetQueryRun	(Inherited from RunBaseReport.)
	run	Contains the code that does the actual job of the class. (Inherited from RunBaseReport.)
	runBase	Returns the RunBase itself. (Inherited from RunBase.)
	runBaseDialogModifyType_RU	(Inherited from RunBase.)
	runsImpersonated	Indicates whether the batch job is run by using the account of the user who created the job. (Overrides the runsImpersonated Method.)
	runWebReport	(Inherited from RunBaseReport.)
	saveLast	Saves the last choice by using the RunBase.pack Method. (Inherited from RunBaseBatch.)
	setDesign	(Overrides the setDesign Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showAsGraph	(Overrides the showAsGraph Method.)
	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 to add a Default button to the dialog. If you change the return value to true, it will add the button. (Inherited from RunBaseReport.)
	showDialog	(Overrides the showDialog Method.)
	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. (Overrides the showIndexFields Method.)
	showPrinterSelect	(Overrides the showPrinterSelect Method.)
	showQuerySelectButton	(Overrides the showQuerySelectButton Method.)
	showQueryValues	Indicates whether to add a Select button to the dialog box. (Overrides the showQueryValues Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedClass parameter value to an instance of the RunBaseReport 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	(Overrides the validate Method.)
	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 RunbaseReportStd class.
	::createMailer
	::reportDescription
	::reportName
	::serverSendMail

Top

Remarks

All reports which are not inherited from RunBaseReport Class will use this class because the class is instantiated through the SysReportRun Class. The reason for this is to make all reports batchable and to create a standard dialog box.

The dialog box can be "extended" using the typical dialog system. You just have to create a dialog() method on your report, and pack() and unpack() methods if the parameters have to be saved using the lastvalue methods.

Do not inherit from this class. Use RunBaseReport Class instead.

For an example, see Tutorial_RunbaseReportStd.

Inheritance Hierarchy

Object Class
  RunBase Class
    RunBaseBatch Class
      RunBaseReport Class
        RunbaseReportStd Class
          CustAccountStatementExtRunBaseReport Class

See Also

RunBaseReport Class