BankChequeCancel_BR Class [AX 2012]

The BankChequeCancel_BR class cancels a check that was posted by a bank or vendor, and deletes all related information in the system.

Syntax

class BankChequeCancel_BR extends BankChequeCancel

Run On

Called

Methods

	Method	Description
	cancelCustVendTrans	Creates canceling transactions for all vendor transactions that are associated with a check.
	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.)
	closeCancellingSettlements	Updates the settlements created from the customer or vendor transactions so that they cannot be reversed. (Inherited from BankChequeCancel.)
	createCancelInterCompanyLedgerVoucher	Creates a LedgerVoucher object for the intercompany transactions that will be created for the recipient company and adds it to the current LedgerVoucherGroup object. (Inherited from BankChequeCancel.)
	createCancelLedgerVoucher	Creates a LedgerVoucher object for the transactions that will be created for the check company and adds it to the current LedgerVoucherGroup object. (Inherited from BankChequeCancel.)
	createCancellingBankAccountTrans	Creates the bank account transaction that cancels the bank account transaction that corresponds to the check. (Inherited from BankChequeCancel.)
	createCancellingCashBridgeLedgerTrans	Adds a new transaction to the current LedgerVoucher object that cancels the cash or cash-in-transit account posting. (Inherited from BankChequeCancel.)
	createCancellingCustVendTrans	Creates the customer or vendor transaction that cancels the customer or vendor transaction from the recipient of the check. (Inherited from BankChequeCancel.)
	createCancellingInterCompanyTrans	Adds new transactions to the current LedgerVoucher objects that cancel the intercompany account postings. (Inherited from BankChequeCancel.)
	createCancellingPayToLedgerAccountTrans	Creates the ledger transaction that cancels the ledger transaction from the recipient of the check. (Inherited from BankChequeCancel.)
	createCancellingTrans	Creates transactions that cancel the transactions that correspond to the check. (Overrides the createCancellingTrans Method.)
	deleteBankChequePaymTrans	Deletes the BankChequePaymTrans records that were created when the canceled customer or vendor transactions were settled. (Overrides the deleteBankChequePaymTrans Method.)
	deleteLedgerTransFurtherPosting	Deletes LedgerTransFurtherPosting records if the check was printed based on a cash-in-transit account. (Inherited from BankChequeCancel.)
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Inherited from BankChequeCancel.)
	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.)
	getCancelTransTxt	(Inherited from BankChequeCancel.)
	getCashBridgeLedgerTransToCancel	Finds the general journal transaction that corresponds to the cash or cash-in-transit account posting for the check. (Inherited from BankChequeCancel.)
	getCustVendTransToCancel	Finds the customer or vendor transaction that was paid by the check. (Inherited from BankChequeCancel.)
	getFromDialog	Assigns the dialog values to the internal variables. (Inherited from RunBase.)
	getInterCompanyLedgerToCancel	Finds the general journal transactions for the intercompany account postings for the check.
	getInterCompanyLedgerTransToCancel	Finds the general journal transactions for the intercompany account postings for the check. (Inherited from BankChequeCancel.)
	getLast	Sets class values to what is stored in SysLastValue records. (Inherited from BankChequeCancel.)
	getPayToLedgerAccountTransToCancel	Finds the general journal transaction that is the recipient of the check. (Inherited from BankChequeCancel.)
	getRecipientCustVendTable	Finds the customer or vendor who is the recipient of the check. (Inherited from BankChequeCancel.)
	getRunBase	(Inherited from RunBase.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getTransToCancel	Finds the transactions to cancel that correspond to the check. (Overrides the getTransToCancel Method.)
	getVouchersForCancellingTrans	Gets the number sequences and voucher numbers that will be used for posting the transactions that cancel the transaction that correspond to the check. (Inherited from BankChequeCancel.)
	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.)
	initParms	Sets fields on the class that are presented to the user on the BankChequeCancel form. (Inherited from BankChequeCancel.)
	isProcessRunInDifferentCompany_IN	Reads the table buffer. (Inherited from BankChequeCancel.)
	isSettlementProcessRun_IN	Reads the table buffer and uses a container for a specific record. (Inherited from BankChequeCancel.)
	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.)
	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	Initializes a new instance of the RunBase class. (Inherited from RunBase.)
	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 BankChequeCancel class. (Inherited from BankChequeCancel.)
	parmAccountId	Gets or sets the AccountId parameter. (Inherited from BankChequeCancel.)
	parmChequeNum	Gets or sets the ChequeNum parameter. (Inherited from BankChequeCancel.)
	parmCustVendTrans	Gets or sets the CustVendTrans parameter. (Inherited from BankChequeCancel.)
	parmJournalName	Gets or sets the JournalName parameter. (Inherited from BankChequeCancel.)
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmReason	Gets or sets the Reason parameter. (Inherited from BankChequeCancel.)
	parmReasonComment	Gets or sets the ReasonComment parameter. (Inherited from BankChequeCancel.)
	parmRecipientType	Gets or sets the RecipientType parameter. (Inherited from BankChequeCancel.)
	parmReconcile	Gets or sets the Reconcile parameter. (Inherited from BankChequeCancel.)
	parmTransDate	Gets or sets the TransDate parameter. (Inherited from BankChequeCancel.)
	postCancellingTrans	Posts all the ledger transactions that are created by the process. (Inherited from BankChequeCancel.)
	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.)
	removeChequeNumLedgerJournalTrans	Removes the check number from all of the LedgerJournalTrans records that correspond to the check. (Inherited from BankChequeCancel.)
	reset	Resets the class to its default state. (Inherited from RunBase.)
	reverseLedgerTrans_IN	Reverses ledgers for transactions. (Inherited from BankChequeCancel.)
	reverseSettlement	Reverses settlements that correspond to transactions paid by check. (Inherited from BankChequeCancel.)
	reverseTaxWithhold	Reverses withholding taxes that correspond to transactions paid by the check. (Inherited from BankChequeCancel.)
	run	Contains the code that does the actual job of the class. (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.)
	settleCancellingCustVendTrans	Settles the customer or vendor transaction that corresponds to the check with the customer or vendor transaction that canceled it. (Inherited from BankChequeCancel.)
	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.)
	taxWithholdCancelPaymentFee_IN	Creates a record in the table by using the specified parameter. (Inherited from BankChequeCancel.)
	taxWithholdReverseLedgerTrans_IN	Adds a new transaction to the current LedgerVoucher object that cancels the cash or cash-in-transit account posting. (Inherited from BankChequeCancel.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the packedClass parameter value to an instance of the BankChequeCancel class. (Inherited from BankChequeCancel.)
	updateBankAccountTransStatus	Updates the status of the canceled bank account transaction. (Inherited from BankChequeCancel.)
	updateChequeStatus	Updates the status of the canceled bank account transaction. (Inherited from BankChequeCancel.)
	updateCustVendTransCancelReason	Updates the customer or vendor transaction being canceled with the reason for the cancellation. (Inherited from BankChequeCancel.)
	updateRelatedRecords	Updates records related to the canceled check. (Inherited from BankChequeCancel.)
	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.)
	validateToCancelCheque	Validates that the check can be canceled. (Overrides the validateToCancelCheque Method.)
	validateToCancelCustVendTrans	Validates that the check can be canceled.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::newBankChequeTable	Creates a new instance of the BankChequeCancel class and initializes several internal variables by using information from a cheque definition.
	::serverRun	Creates an instance of the BankChequeCancel_BR class from a pack and calls its Run method on the server tier.

Top

Inheritance Hierarchy

Object Class
  RunBase Class
    BankChequeCancel Class
      BankChequeCancel_BR Class