PurchFormletterParmData Class [AX 2012]

Syntax

class PurchFormletterParmData extends formletterParmData

Run On

Server

Methods

	Method	Description
	addPurchStatusRange	Adds a query range with the value that is specified in the purchStatusRange method for the purchase status field of the PurchTable table.
	addToKey	Adds a string value to a key. (Inherited from formletterParmData.)
	addToKey_W
	addToOrigOrderIdSet	Adds reference to set of original order ID.
	allowChooseLines	Determines whether the formletterParmData.doChooseLines method can be executed. (Inherited from formletterParmData.)
	allowCreateParmTable	Indicates whether a posting header record without the associated lines can be created. (Inherited from formletterParmData.)
	allowReArrange	Indicates whether a purchase posting can be rearranged.
	calcAutomaticTotalDiscount
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canGetPurchIdFromParmTable	Indicates whether the purchId field can be taken from the parm table.
	catchAll	Performs clean-up if an exception is thrown. (Inherited from formletterParmData.)
	checkAdvancePayments_W	Is a stub method that checks for advance payments. (Inherited from formletterParmData.)
	checkBeforePost	Indicates whether to perform validation before posting. (Inherited from formletterParmData.)
	checkifPackingSlipExistForBOE_IN	Checks if packing slip exist for BOE.
	checkIfPurchOrderExist
	chooseLinesChangedSourceTable	Indicates whether the source table in the SysQueryRun object has changed. (Inherited from formletterParmData.)
	chooseLinesFromLineEnd	Runs when the records that are based on a list of order lines in the posting parameter tables are created. (Inherited from formletterParmData.)
	chooseLinesFromLineGetSourceLine	Gets the current source line for the formletterParmData.doChooseLinesFromLine method. (Inherited from formletterParmData.)
	chooseLinesGetInventOwner_RU	Gets the InventOwnerId value of the current source line from the ChooseLines query. (Inherited from formletterParmData.)
	chooseLinesGetSourceLine	Gets the current source line from the SysQueryRun object. (Inherited from formletterParmData.)
	chooseLinesGetSourceTable	Gets the current source table from the SysQueryRun object. (Inherited from formletterParmData.)
	chooseLinesNext	Calls next on the SysQueryRun object. (Inherited from formletterParmData.)
	cleanupChooseLines	Re-enables a source table in a query. (Inherited from formletterParmData.)
	createData	Creates the data on which the posting is to be based. (Inherited from formletterParmData.)
	createData_IN	Creates data.
	createFromHistoryParmLine_Asset
	createFromHistoryParmLines	Inserts records in the order line posting table. (Overrides the createFromHistoryParmLines Method.)
	createFromHistoryParmSubTables	Inserts records in the order header sub posting table. (Overrides the createFromHistoryParmSubTables Method.)
	createFromHistoryParmTable	Inserts a record in the order header posting table. (Overrides the createFromHistoryParmTable Method.)
	createParmLine	Creates a purchase parameter line and purchase parameter asset line for the given purchase line. (Overrides the createParmLine Method.)
	createParmLineAsset	Creates the parameter line that holds the fixed asset data.
	createParmLinesForBOE_IN	Creates parameter lines for BOE.
	createParmSubTable	Inserts a record into the sub order header posting parameter table. (Overrides the createParmSubTable Method.)
	createParmTable	Inserts a record into the order header posting parameter table. (Overrides the createParmTable Method.)
	createParmUpdate	Inserts a record into the order posting parameter table. (Overrides the createParmUpdate Method.)
	defaultParmTable
	defaultSpecQty
	defaultStorno	Retrieves the default value for the Storno parameter.
	defaultSumBy
	deleteParmLine	Deletes a record from the order line posting parameter table. (Overrides the deleteParmLine Method.)
	deleteParmLines	Deletes records in the order line posting parameter table for the current posting. (Overrides the deleteParmLines Method.)
	deleteParmSubTable	Deletes the subheader table records that correspond to the specified purchase order.
	deleteParmTable	Deletes the header table records that correspond to the specified purchase order.
	deleteParmTables	Deletes records in the order header posting parameter table for the current posting. (Overrides the deleteParmTables Method.)
	doChooseLines_IN	The event handler when lines are selected. (Inherited from formletterParmData.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	existsParmLines	Determines whether order line posting parameter records exist for the current posting. (Overrides the existsParmLines Method.)
	existsParmSubTable	Determines whether the specified record exists. (Overrides the existsParmSubTable Method.)
	existsParmUpdate	Determines whether a posting parameter record exists. (Overrides the existsParmUpdate Method.)
	fieldIdParmTable_TableRefId	Gets the field ID for the TableRefID field in the posting parameter header table. (Overrides the fieldIdParmTable_TableRefId Method.)
	fieldIdSourceTable_OrderId	Gets the field ID for the field that contains the order ID in the source table. (Overrides the fieldIdSourceTable_OrderId Method.)
	fillOrigOrderIsSet	Fills the internal set of original order IDs that are being processed. (Overrides the fillOrigOrderIsSet Method.)
	fillOutputContract	Fills the FormletterParmDataOutputContract contract with data. (Overrides the fillOutputContract Method.)
	findPackingSlipForBOECorr_IN	Returns the vendpackingslip trans buffer, if exist for the Packingslip while doing a packingslip correction.
	getLineQuantities	Retrieves quantities from the purchase order line to use for the parameter line generation.
	getOutputContract	Gets the FormletterParmDataOutputContract object. (Inherited from formletterParmData.)
	getOutputContractPacked	Gets a packed version of the FormletterParmDataOutputContract object. (Inherited from formletterParmData.)
	getParmTableNum	Retrieves the Num value of the header to use in the createParmTable method.
	getSourceTableFromSourceLine	Retrieves the PurchTable record of the PurchLine record passed in. (Overrides the getSourceTableFromSourceLine Method.)
	getSplitInventOwnerId_RU	Determines whether the result document should be split by inventory owner dimension on its lines. (Inherited from formletterParmData.)
	getSplitInventProfileType_RU	Determines whether the result document should be split by inventory profile dimension on its lines. (Inherited from formletterParmData.)
	getSplitPostingProfile_RU	Determines whether the result document should be split by posting profile on its lines. (Inherited from formletterParmData.)
	getTableRefId	Gets a table reference ID. (Inherited from formletterParmData.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getWithholdingTaxAmount_IN	Gets withholding tax amount.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	infoSourceTableSkipped	Called when a source table record is skipped. (Overrides the infoSourceTableSkipped Method.)
	init	Initializes the class. (Overrides the init Method.)
	initChooseLines	Allows method to be overridden so that some initialization at the start of the ChooseLinesmethod can be done. (Inherited from formletterParmData.)
	initChooseLinesFromLine	Starts creating records in the posting parameter tables, depending on the specified list of order line records. (Inherited from formletterParmData.)
	initLinesQuery	Initializes the query. (Inherited from formletterParmData.)
	initOfficials_RU	Initializes officials for update. (Inherited from formletterParmData.)
	initParmLine	Retrieves the correct type of the table buffer to initialize a line.
	initParmLine_Asset	Retrieves the correct type of table buffer to initialize a line asset.
	initParmSubTable	Retrieves the correct type of table buffer to initialize a sub header.
	initParmTable	Retrieves the correct type of table buffer to initialize the header.
	initParmTableFromLine	Updates the header from line header.
	initQueryBuild	Initializes the chooseLines query. (Inherited from formletterParmData.)
	initRecordLists	Creates the record list and map variables. (Overrides the initRecordLists Method.)
	insertParmLine	Inserts a record into the order line posting parameter table. (Overrides the insertParmLine Method.)
	insertParmLine_Asset
	insertParmSubTable	Inserts a record into the sub order header posting parameter table. (Overrides the insertParmSubTable Method.)
	insertParmSubTableMap	Inserts the specified record into the map that keeps track of the records. (Inherited from formletterParmData.)
	insertParmTable	Inserts a record in the order header posting parameter table. (Overrides the insertParmTable Method.)
	insertParmTableMap	Inserts the specified record into the map that keeps track of these records. (Inherited from formletterParmData.)
	insertParmUpdate	Inserts a record in the posting parameter table. (Inherited from formletterParmData.)
	insertRecordLists	Inserts records in the record lists into the database. (Overrides the insertRecordLists Method.)
	interCompanyParmLine	Gets and sets the posting parameter line for an intercompany line. (Overrides the interCompanyParmLine Method.)
	interCompanyParmLineQty	Gets or sets the quantity for an intercompany line. (Inherited from formletterParmData.)
	inventProfileType_RU	Returns InventProfileType_RU actual for update
	invoiceAccountInQuery
	lateSelection	Determines whether the late selection is used. (Overrides the lateSelection Method.)
	lateSelectionQuery	Gets the query to use in the late selection. (Overrides the lateSelectionQuery Method.)
	lineListTableId	Retrieves the table ID from the list of order line records that are specified. (Inherited from formletterParmData.)
	loadLastUsedQuery	Determines whether to use the last used query when the prompt of the SysQueryRun object executes. (Inherited from formletterParmData.)
	mayJournalBePosted	Determines whether a parameter table record should be created for a given source table. (Overrides the mayJournalBePosted Method.)
	mayJournalBePosted_IN	Checks whether the journal should be posted. (Inherited from formletterParmData.)
	mayJournalTransBePosted	Determines whether a parameter line is to be created for a given source line. (Inherited from formletterParmData.)
	mcrSplitData	Splits the parm table and parm lines further parm tables and parm lines. (Inherited from formletterParmData.)
	needVarianceApproval	Indicates whether the specified header table record needs variance approval.
	new	Initializes a new instance of the PurchFormletterParmData class. (Overrides the new Method.)
	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.)
	packExtensions	Packs VendInvoiceInfoTable_RU, VendInvoiceInfoTable_RU and or VendInvoiceInfoTable_RU from the _oldParmTable to _newParmTable.
	parmAllowEmptyParmTable	Gets or sets the AllowEmptyParmTable parameter. (Inherited from formletterParmData.)
	parmCallerTable	Gets or sets the CallerTable parameter. (Inherited from formletterParmData.)
	parmClearTotals	Gets or sets the ClearTotals parameter.
	parmCreateFromHistory	Gets or sets the CreateFromHistory parameter. (Inherited from formletterParmData.)
	parmCreateFromLines	Gets or sets the CreateFromLines parameter. (Inherited from formletterParmData.)
	parmCreditRemaining	Gets or sets the CreditRemaining parameter.
	parmCustomsBillOfEntryNumber_IN	The parameter of customs bill of entry number.
	parmCustomsImporterInvoiceNumber_IN	The customs importer invoice number parameter.
	parmCustomsImportOrderType_IN	The customs import order type parameter.
	parmDatasourceRecordsPacked	Gets or sets the DatasourceRecordsPacked parameter. (Inherited from formletterParmData.)
	parmDeletePurchLineRecIdSet	Gets or sets the DeletePurchLineRecIdSet parameter.
	parmDeletePurchTablePurchIdSet	Gets or sets the DeletePurchTablePurchIdSet parameter.
	parmDocumentOrigin	Gets or sets the DocumentOrigin parameter.
	parmDocumentStatus	Gets or sets the DocumentStatus parameter. (Inherited from formletterParmData.)
	parmExchRate_RU	Gets or sets the ExchRate_RU parameter.
	parmExecuteLateSelection	Gets or sets the ExecuteLateSelection parameter. (Inherited from formletterParmData.)
	parmExternalDefaultedParmTable	Gets or sets the ExternalDefaultedParmTable parameter.
	parmFixedExchRate_RU	Gets or sets the FixedExchRate_RU parameter.
	parmForceUpdate_W	Gets or sets the ForceUpdate_W parameter. (Inherited from formletterParmData.)
	parmHistoryList	Gets or sets the HistoryList parameter. (Inherited from formletterParmData.)
	parmId	Gets the Id parameter. (Inherited from formletterParmData.)
	parmInterCompanyCompanyId	Gets or sets the InterCompanyCompanyId parameter. (Inherited from formletterParmData.)
	parmInterCompanyMap	Gets or sets the InterCompanyMap parameter. (Inherited from formletterParmData.)
	parmInterCompanyParmId	Gets or sets the InterCompanyParmId parameter. (Inherited from formletterParmData.)
	parmInterCompanyParmSelectFromJournal	Gets or sets the InterCompanyParmSelectFromJournal parameter. (Inherited from formletterParmData.)
	parmInventLocationId_PL	Gets or sets the InventLocationId_PL parameter.
	parmInventProfileType_RU	Gets or sets the InventProfileType_RU parameter.
	parmIsInBatch	Gets or sets the IsInBatch parameter. (Inherited from formletterParmData.)
	parmLedgerJournalTrans	Gets or sets the LedgerJournalTrans parameter. (Inherited from formletterParmData.)
	parmLineAssetTableId	Gets the LineAssetTableId parameter.
	parmLineBOEMapKey_IN	The parameter line of BOE map key.
	parmLineList	Gets or sets the LineList parameter. (Inherited from formletterParmData.)
	parmLineMapKey	Packs fields that represent unique identification of the document line to hash string. (Overrides the parmLineMapKey Method.)
	parmLineTableId	Gets the LineTableId parameter. (Overrides the parmLineTableId Method.)
	parmMCRPickWaveReference	Gets or sets the pick wave reference. (Inherited from formletterParmData.)
	parmMultiForm	Gets or sets the MultiForm parameter. (Inherited from formletterParmData.)
	parmNewPurchLineRecIdSet	Gets or sets the NewPurchLineRecIdSet parameter.
	parmNumber	Gets or sets the Number parameter.
	parmOnlyCreateParmUpdate	Gets or sets the OnlyCreateParmUpdate parameter. (Inherited from formletterParmData.)
	parmParmId	Gets or sets the ParmId parameter. (Inherited from formletterParmData.)
	parmParmIdSynched	Gets or sets the ParmIdSynched parameter. (Inherited from formletterParmData.)
	parmParmTable_W	Gets or sets the ParmTable_W parameter. (Overrides the parmParmTable_W Method.)
	parmParmTableNum	Gets or sets the ParmTableNum parameter.
	parmParmUpdate	Gets or sets the ParmUpdate parameter. (Overrides the parmParmUpdate Method.)
	parmParmUpdateSysLastValue	Gets or sets the ParmUpdateSysLastValue parameter. (Inherited from formletterParmData.)
	parmPostingProfile_RU	Gets or sets the PostingProfile_RU parameter.
	parmProcessAdditional	Gets or sets the ProcessAdditional parameter.
	parmProforma	Gets or sets the Proforma parameter. (Inherited from formletterParmData.)
	parmQueryChooseLines	Gets or sets the QueryChooseLines parameter. (Inherited from formletterParmData.)
	parmQueryChooseLinesPendingInvoice	Gets and sets the query that is used on the VendInvoiceInfoTable table to select the lines to copy to the table header.
	parmSADNumberCode_PL	Gets or sets the SADNumberCode_PL parameter.
	parmShowQueryForm	Gets or sets the ShowQueryForm parameter. (Inherited from formletterParmData.)
	parmSkipParmTableDefaulting	Gets or sets the SkipParmTableDefaulting parameter.
	parmSourceTable	Gets or sets the SourceTable parameter. (Overrides the parmSourceTable Method.)
	parmSpecQty	Gets or sets the SpecQty parameter.
	parmStorno_RU	Gets or sets the Storno_RU parameter.
	parmSubTableMapKey	Generates a key for the specified record. (Overrides the parmSubTableMapKey Method.)
	parmSubTableTableId	Gets the SubTableTableId parameter. (Overrides the parmSubTableTableId Method.)
	parmTableMapKey	Packs fields that represent unique identification of the document header to hash string. (Overrides the parmTableMapKey Method.)
	parmTableTableId	Gets the TableTableId parameter. (Overrides the parmTableTableId Method.)
	parmTransDate	Gets or sets the TransDate parameter. (Inherited from formletterParmData.)
	parmUsePackedMapInChooseLinesQuery	Gets or sets the UsePackedMapInChooseLinesQuery parameter. (Inherited from formletterParmData.)
	parmUsePostingProfileFromContract_RU	Gets or sets the UsePostingProfileFromContract_RU parameter.
	parmVersioningStrategy	Gets or sets the VersioningStrategy parameter. (Inherited from formletterParmData.)
	parmWasQueryFormCancelled	Gets or sets the WasQueryFormCancelled parameter. (Inherited from formletterParmData.)
	pdsCWGetLineQuantities	Retrieves the catch weight quantities from the purchase order line that will be used for the parameter line generation.
	pdsCWInterCompanyParmLineQty	(Inherited from formletterParmData.)
	pdsCWQtyInvent	Delegates the calculation of the catch weight quantities to the associated PurchQuantity object.
	postingProfile_RU	Retrieves the vendor posting profile that is associated with the PurchLine if invoices in update should be splitted by posting profiles or with the PurchTable if not.
	processAdditional	Overrides method to support processing of additional lines in parameter tables that were used by the purchase invoice. (Inherited from formletterParmData.)
	promptChooseLines	Executes the prompt of the ChooseLines query on the client-side if the class is currently running on the server. (Inherited from formletterParmData.)
	purchID_W	Determines current purchase Id.
	purchStatusRange	Retrieves the purchase status range to use for selecting purchase orders to be updated.
	qtyDeviation_RU	Returns the deviation qty for the current line update.
	qtyInvent
	qtyPurch
	queryName	Gets the name of the query to use to create data. (Overrides the queryName Method.)
	reArrange	Performs a re-arrange of the created data. (Inherited from formletterParmData.)
	reArrangeCreateNewJournal
	reArrangeEnd	Called when the re-arrange of data has completed. (Overrides the reArrangeEnd Method.)
	reArrangeInit	Initializes the re-arrange process. (Overrides the reArrangeInit Method.)
	reArrangeLines	Re-arranges the record in the line posting parameter table. (Overrides the reArrangeLines Method.)
	reArrangeQueryRun	Gets the QueryRun object that is used in the re-arrange process. (Overrides the reArrangeQueryRun Method.)
	reArrangeSplit	Performs a split of the re-arranged data. (Overrides the reArrangeSplit Method.)
	reArrangeUpdateParmLine
	reArrangeUpdateParmSingleLine	The method should be overriden bu descendants to perform document-specific actions before line rearrange.
	reArrangeUpdateParmSubTable
	recIdSuspensionTables	Gets a list of tables that should have suspended record ID generation. (Overrides the recIdSuspensionTables Method.)
	removeRecIdSuspension	Removes a Record ID suspension. (Inherited from formletterParmData.)
	reSelect	Performs a re-select of the created data. (Inherited from formletterParmData.)
	reSelectEnd	Called when the re-selection of data is completed. (Inherited from formletterParmData.)
	reSelectInit	Initializes the re-select process. (Inherited from formletterParmData.)
	reSelectLine	Creates a parameter line record during reselect, depending on whether journal transactions can be posted. (Inherited from formletterParmData.)
	reSelectLines	Re-selects the record in the line posting parameter table. (Overrides the reSelectLines Method.)
	reselectSummaryPackingSlip_W	Is a stub method that rereads a packing slip record. (Inherited from formletterParmData.)
	selectChooseLines	Executes either the formletterParmData.doChooseLinesFromLine method or the formletterParmData.doChooseLines method. (Inherited from formletterParmData.)
	setHoldOrNotApproved
	setInterCompanyInventDim	Sets the intercompany inventory dimensions on a parameter line.
	setNewPostingPurchAndInventQty_IN	Sets new posting purch and invent quantity.
	setParmTableLog
	setPreviousVersionQuantityFields	Sets the previous version quantity fields for documents that support versioning.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	skipMayJournalBePosted	Determines whether to skip the call to the MayJournalBePosted method when it creates data. (Overrides the skipMayJournalBePosted Method.)
	skipOrderIdInReSelect	Indicates whether the origPurchId value should be skipped in the reSelect method.
	sourceLineTableId	Gets the table ID for the source line table. (Overrides the sourceLineTableId Method.)
	sourceTableChanged	Indicates whenever the source table is changed. (Inherited from formletterParmData.)
	sourceTableTableId	Gets the table ID for the source table. (Overrides the sourceTableTableId Method.)
	splitDeliveryInformation_IN	Splits delivery information.
	splitInventOwnerId_RU	Determines whether splitting of the posting parameter lines by inventory owner ID is supported. (Inherited from formletterParmData.)
	splitInventProfileType_RU	Determines if invoices in update should be splitted by inventory profile types (Overrides the splitInventProfileType_RU Method.)
	splitPostingProfile_RU	Determines if invoices in update should be splitted by posting profiles (Overrides the splitPostingProfile_RU Method.)
	sumNum
	suspendRecIds	Suspends record ID generation. (Inherited from formletterParmData.)
	tableRefIdUsed	Gets or sets a Boolean value that indicates whether the current table reference ID is used. (Inherited from formletterParmData.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	transDate
	updateParmTable
	updateParmTableSplit	Updates the posting parameter header record according to the split settings. (Inherited from formletterParmData.)
	updateQueryBuild	Updates the Query that is used during data creation. (Overrides the updateQueryBuild Method.)
	updateQueryBuild_IN	Updates the query build.
	updateQueryBuildLines	Updates the chooseLines query with line conditions and sort fields.
	updateQueryBuildSpecQty	Updates the query ranges specific to SpecQty settings.
	updateQueryDocumentRanges	Adds ranges on order ID to the query used when it creates data. (Overrides the updateQueryDocumentRanges Method.)
	updateTableSplit_IN	Updates the table split information.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	useLateSelectionQuery	Determines whether the late selection query should be used. (Overrides the useLateSelectionQuery Method.)
	useSplitting	Determines whether the splitting of posting parameter lines is supported. (Overrides the useSplitting Method.)
	vendAccountInQuery
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::allowJournal
	::chooseLinesServer	Creates posting data.
	::chooseLinesServer_IN	Choose lines server.
	::chooseLinesServerIL
	::executeChooseLinesServer
	::initpurchParmUpdateFormletter
	::newChooseLines	Initializes a new instance of the PurchFormletterParmData class.
	::newData
	::newReArrange
	::newReSelect
	::reArrangeServer
	::reSelectServer

Top

Inheritance Hierarchy

Object Class
  formletterParmData Class
    PurchFormletterParmData Class
      PurchFormletterParmDataBOE_IN Class
      PurchFormletterParmDataI4P_RU Class
      PurchFormletterParmDataInvoice Class
      PurchFormletterParmDataPackingSlip Class
      PurchFormletterParmDataPurchOrder Class
      PurchFormletterParmDataReceiptsList Class