BankChequeCancel Class [AX 2012]

The BankChequeCancel class cancels a check and all its related information in the system.

Syntax

class BankChequeCancel extends RunBase

Run On

Called

Methods

	Method	Description
	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.)
	checkTaxWithholdFeeType_IN	Reads the record from the table and checks for the existence of the record.
	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.
	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.
	createCancelLedgerVoucher	Creates a LedgerVoucher object for the transactions that will be created for the check company and adds it to the current LedgerVoucherGroup object.
	createCancellingBankAccountTrans	Creates the bank account transaction that cancels the bank account transaction that corresponds to the check.
	createCancellingCashBridgeLedgerTrans	Adds a new transaction to the current LedgerVoucher object that cancels the cash or cash-in-transit account posting.
	createCancellingCustVendTrans	Creates the customer or vendor transaction that cancels the customer or vendor transaction from the recipient of the check.
	createCancellingInterCompanyTrans	Adds new transactions to the current LedgerVoucher objects that cancel the intercompany account postings.
	createCancellingPayToLedgerAccountTrans	Creates the ledger transaction that cancels the ledger transaction from the recipient of the check.
	createCancellingTrans	Creates the transactions that cancel the transactions that correspond to the check.
	deleteBankChequePaymTrans	Deletes the BankChequePaymTrans records created when settling the canceled customer or vendor transactions.
	deleteLedgerTransFurtherPosting	Deletes LedgerTransFurtherPosting records if the check was printed based on a cash-in-transit account.
	dialog	Returns a class that contains the methods that are described by the RunBaseDialogable interface. (Overrides the dialog Method.)
	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
	getCashBridgeLedgerTransToCancel	Finds the general journal transaction that corresponds to the cash or cash-in-transit account posting for the check.
	getCustVendTransToCancel	Finds the customer or vendor transaction that was paid by the check.
	getFromDialog	Assigns the dialog values to the internal variables. (Inherited from RunBase.)
	getGeneralJournalAcctEntryByPostingType	Gets the record ID of the general journal transaction for a specific posting type.
	getInterCompanyLedgerTransToCancel	Finds the general journal transactions for the intercompany account postings for the check.
	getLast	Sets class values to what is stored in SysLastValue records. (Overrides the getLast Method.)
	getPayToLedgerAccountTransToCancel	Finds the general journal transaction that is the recipient of the check.
	getRecipientCustVendTable	Finds the customer or vendor who is the recipient of the check.
	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.
	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.
	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.
	isProcessRunInDifferentCompany_IN	Reads the table buffer.
	isSettlementProcessRun_IN	Reads the table buffer and uses a container for a specific record.
	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. (Overrides the pack Method.)
	parmAccountId	Gets or sets the AccountId parameter.
	parmChequeNum	Gets or sets the ChequeNum parameter.
	parmCustVendTrans	Gets or sets the CustVendTrans parameter.
	parmJournalName	Gets or sets the JournalName parameter.
	parmProgress	Gets or sets the Progress parameter. (Inherited from RunBase.)
	parmReason	Gets or sets the Reason parameter.
	parmReasonComment	Gets or sets the ReasonComment parameter.
	parmRecipientType	Gets or sets the RecipientType parameter.
	parmReconcile	Gets or sets the Reconcile parameter.
	parmTransDate	Gets or sets the TransDate parameter.
	postCancellingTrans	Posts all the ledger transactions that are created by the process.
	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.
	reset	Resets the class to its default state. (Inherited from RunBase.)
	reverseLedgerTrans_IN	Reverses ledgers for transactions.
	reverseSettlement	Reverses settlements that correspond to transactions paid by check.
	reverseTaxWithhold	Reverses withholding taxes that correspond to transactions paid by the check.
	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.
	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.
	taxWithholdFeeReversal_IN	Creates an object and adds a transaction by passing the record.
	taxWithholdReverseLedgerTrans_IN	Adds a new transaction to the current LedgerVoucher object that cancels the cash or cash-in-transit account posting.
	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. (Overrides the unpack Method.)
	updateBankAccountTransStatus	Updates the status of the canceled bank account transaction.
	updateChequeStatus	Updates the status of the canceled bank account transaction.
	updateCustVendTransCancelReason	Updates the customer or vendor transaction being canceled with the reason for the cancellation.
	updateRelatedRecords	Updates records related to the canceled check.
	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.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::description	Gets the description of the class.
	::findCustVendTransForCheque	Finds the customer or vendor transaction that corresponds to the check.
	::findCustVendTransForCheque_IN	Reads the table buffer and gets the required table.
	::isPartialTaxSettlementProcessRun_IN	Checks whether any partially settled customer or vendor transactions exist.
	::isSalesTaxSettlementProcessRun_IN	Checks whether any partially settled vendor transactions exist.
	::main	Provides an entry point for the BankChequeCancel class when it is called from a menu item.
	::newBankChequeTable	Creates a new instance of the BankChequeCancel class and initializes several internal variables with information from a Cheque definition.
	::serverRun	Creates an instance of the BankChequeCancel 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