RunBaseBatch Class

All jobs that must be able to run in a batch must inherit from this class.

class RunBaseBatch extends RunBase implements Batchable

Run On

Called

Methods

Method

Description

allowSaveLast

batchInfo

Returns the BatchInfo class. This class is the API for the batch table.

cancelTimeOut

Cancels a previous method call to the Object::setTimeOut Method. (Inherited from Object.)

canGoBatch

Overridden. Returns false

canGoBatchJournal

Determines whether the class is shown in the list of Journal types.

canSwapBetweenCS

Controls whether a calledFrom class that is instantiated on the server should have its prompt executed on the client. (Inherited from RunBase.)

canSwapBetweenCSPrim

Returns whether it is possible to pack the class, reinstantiate a new class on the client or server, and unpack the packed class into the new class. (Inherited from RunBase.)

caption

Overridden.

checkCloseDialog

Must be called in the RunBase dialog CloseOk method. (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. (Inherited from RunBase.)

dialogClear

Should clear the contents of the dialog. (Inherited from RunBase.)

dialogInit

Initializes the dialog. (Inherited from RunBase.)

dialogMake

Obtains the dialog from a RunBase class. (Inherited from RunBase.)

dialogPost

Overridden.

dialogPostInit

Called right after the RunBase.dialogInit Method. (Inherited from RunBase.)

dialogPostRun

Called after Dialog.run Method. (Inherited from RunBase.)

dialogReInit

Reinitializes the dialog. (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 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. (Inherited from RunBase.)

equal

Determines whether the specified object is equal to the current one. (Inherited from Object.)

getFromDialog

Overridden.

getLast

Overridden. Gets the last choice stored in the last value table.

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

initParmDefault

Intializes the internal variables. Called when no SysLastValue record can be found, in SysLastValue.GetLast(). (Inherited from RunBase.)

initSysSign

(Inherited from RunBase.)

isInBatch

Determines whether the RunBaseBatch is actually being run from a batch server.

isSwappingPrompt

Checks if the program is currently swapping from server to client. (Inherited from RunBase.)

isSysSignUsed

(Inherited from RunBase.)

lastValueDataAreaId

(Inherited from RunBase.)

lastValueDesignName

(Inherited from RunBase.)

lastValueElementName

(Inherited from RunBase.)

lastValueType

(Inherited from RunBase.)

lastValueUserId

(Inherited from RunBase.)

mustGoBatch

mustLoadSaveQuery

Determines whether the last query must be loaded and saved when you leave the form. Called from SysQueryForm. (Inherited from RunBase.)

name

Returns the name of the RunBase class. (Inherited from RunBase.)

new

Overridden. Initializes a new instance of the RunBaseBatch class.

notify

Releases the hold on an object that has called a wait method on this object. (Inherited from Object.)

notifyAll

Releases a lock on the object that was issued by a 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 RunBase class. (Inherited from RunBase.)

parmCurrentBatch

Gets or sets the CurrentBatch parameter.

parmInBatch

Gets or sets the InBatch parameter.

parmProgress

Gets or sets the Progress parameter. (Inherited from RunBase.)

parmSysSign

Gets or sets the SysSign parameter. (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

Overridden. Displays the class’s dialog and awaits user input.

promptPack

Overridden.

promptPrim

Contains the code for the prompt functionality. The RunBase.prompt Method simply wraps this method. (Inherited from RunBase.)

promptUnpack

Overridden.

putToDialog

Enables setting the fields that were just added in the RunBase.dialog Method. This method is called from the RunBase.promptPrim Method directly following the RunBase.dialogMake Method. (Inherited from RunBase.)

queryRun

Returns the QueryRun, which is used by the QueryPrompt. (Inherited from RunBase.)

reset

Resets the class to its default state. (Inherited from RunBase.)

run

Contains the code that does the actual job of the class. (Inherited from RunBase.)

runBase

Returns the RunBase itself. (Inherited from RunBase.)

runsImpersonated

Determines whether the batch task is run on the server or on a client.

saveLast

Overridden.

setGetLastCalled

Sets the internal inGetSaveLast variable. (Inherited from RunBase.)

setInPrompt

Sets the internal inPrompt variable. (Inherited from RunBase.)

setIsSwappedFromServer

Sets the internal isSwappedFromServer variable. (Inherited from RunBase.)

setTimeOut

Sets up the scheduled execution of a specified method. (Inherited from Object.)

showBatchTab

showClearButton

Determines whether to add a Clear button to the dialog. 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. 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. If you change the return value to true, the button will be added. (Inherited from RunBase.)

sysSignFieldId

(Inherited from RunBase.)

sysSignTableId

(Inherited from RunBase.)

sysSignValidateEmployee

(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 RunBase class. (Inherited from RunBase.)

usageCount

Returns the current number of references (the value of the reference counter) that the object has. (Inherited from Object.)

validate

Overridden.

wait

Pauses a process. (Inherited from Object.)

xml

Returns an XML string that represents the current object. (Inherited from Object.)

Remarks

You will have to consider what RunBaseBatch.canGoBatch Method and RunBaseBatch.canGoBatchJournal Method should return.

For examples, see RunBase Class and Tutorial_RunbaseBatch Class.

See Also

RunBase Class

RunBaseReport Class