formletterParmData Class [AX 2012]

The FormletterParmData class is a base class that is used by specialized classes for creating the data that a specified order update is based on.

Syntax

class formletterParmData

Run On

Server

Methods

	Method	Description
	addToKey	Adds a string value to a key.
	allowChooseLines	Determines whether the formletterParmData.doChooseLines method can be executed.
	allowCreateParmTable	Indicates whether a posting header record without the associated lines can be created.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	catchAll	Performs clean-up if an exception is thrown.
	checkAdvancePayments_W	Is a stub method that checks for advance payments.
	checkBeforePost	Indicates whether to perform validation before posting.
	chooseLinesChangedSourceTable	Indicates whether the source table in the SysQueryRun object has changed.
	chooseLinesFromLineEnd	Runs when the records that are based on a list of order lines in the posting parameter tables are created.
	chooseLinesFromLineGetSourceLine	Gets the current source line for the formletterParmData.doChooseLinesFromLine method.
	chooseLinesGetInventOwner_RU	Gets the InventOwnerId value of the current source line from the ChooseLines query.
	chooseLinesGetSourceLine	Gets the current source line from the SysQueryRun object.
	chooseLinesGetSourceTable	Gets the current source table from the SysQueryRun object.
	chooseLinesNext	Calls next on the SysQueryRun object.
	cleanupChooseLines	Re-enables a source table in a query.
	createData	Creates the data on which the posting is to be based.
	createFromHistory	Inserts records into posting parameter tables that are based on the previous posted records in the posting parameter tables.
	createFromHistoryParmLines	Inserts records in the order line posting parameter table.
	createFromHistoryParmSubTables	Inserts records in the order header sub posting parameter table.
	createFromHistoryParmTable	Inserts a record in the order header posting parameter table.
	createParmLine	Inserts a record in the order line posting parameter table.
	createParmSubTable	Inserts a record in the sub order header posting parameter table.
	createParmTable	Inserts a record in the order header posting parameter table.
	createParmUpdate	Inserts a record in the order posting parameter table.
	deleteParmLine	Deletes a record from the order line posting parameter table.
	deleteParmLines	Deletes records in the order line posting parameter table for the current posting.
	deleteParmTables	Deletes records in the order header posting parameter table for the current posting.
	doChooseLines	Creates records in the posting parameter tables.
	doChooseLines_IN	The event handler when lines are selected.
	doChooseLinesFromLine	Creates records in the posting parameter tables that are based on the specified list of order line records.
	doMayJournalBePosted	Determines whether the order can be posted.
	doReArrange	Performs a re-arrange for the records in the posting parameter tables.
	doReSelect
	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.
	existsParmSubTable	Indicates whether the specified record exists.
	existsParmUpdate	Determines whether a posting parameter record exists.
	fieldIdParmTable_TableRefId	Gets the field ID for the TableRefID field in the posting parameter header table.
	fieldIdSourceTable_OrderId	Gets the field ID for the field that contains the order ID in the source table.
	fillOrigOrderIsSet	Fills the internal set of original order IDs that are being processed.
	fillOutputContract	Fills the FormletterParmDataOutputContract object by using data.
	getOutputContract	Gets the FormletterParmDataOutputContract object.
	getOutputContractPacked	Gets a packed version of the FormletterParmDataOutputContract object.
	getSourceTableFromSourceLine	Retrieves the order header record for the order line specified.
	getSplitInventOwnerId_RU	Determines whether the result document should be split by inventory owner dimension on its lines.
	getSplitInventProfileType_RU	Determines whether the result document should be split by inventory profile dimension on its lines.
	getSplitPostingProfile_RU	Determines whether the result document should be split by posting profile on its lines.
	getTableRefId	Gets a table reference ID.
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	infoSourceTableSkipped	Called when a source table record is skipped.
	init	Initializes the class.
	initChooseLines	Allows method to be overridden so that some initialization at the start of the ChooseLinesmethod can be done.
	initChooseLinesFromLine	Starts creating records in the posting parameter tables, depending on the specified list of order line records.
	initLinesQuery	Initializes the query.
	initOfficials_RU	Initializes officials for update.
	initQueryBuild	Initializes the chooseLines query.
	initRecordLists	Creates the record list and map variables.
	insertParmLine	Inserts a record in the order line posting parameter table.
	insertParmSubTable	Inserts a record in the sub order header posting parameter table.
	insertParmSubTableMap	Inserts the specified record into the map that keeps track of the records.
	insertParmTable	Inserts a record in the order header posting parameter table.
	insertParmTableMap	Inserts the specified record into the map that keeps track of these records.
	insertParmUpdate	Inserts a record in the posting parameter table.
	insertRecordLists	Inserts the records that are in the record lists into the database.
	interCompanyParmLine	Gets and sets the posting parameter line for an intercompany line.
	interCompanyParmLineQty	Gets or sets the quantity for an intercompany line.
	lateSelection	Determines whether last selection is used.
	lateSelectionQuery	Gets the query to use in late selection.
	lineListTableId	Retrieves the table ID from the list of order line records that are specified.
	loadLastUsedQuery	Determines whether to use the last used query when the prompt of the SysQueryRun object executes.
	mayJournalBePosted	Determines whether a parameter table record is to be created for a given source table.
	mayJournalBePosted_IN	Checks whether the journal should be posted.
	mayJournalTransBePosted	Determines whether a parameter line is to be created for a given source line.
	mcrSplitData	Splits the parm table and parm lines further parm tables and parm lines.
	new	Initializes a new instance of the formletterParmData class.
	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.)
	parmAllowEmptyParmTable	Gets or sets the AllowEmptyParmTable parameter.
	parmCallerTable	Gets or sets the CallerTable parameter.
	parmCreateFromHistory	Gets or sets the CreateFromHistory parameter.
	parmCreateFromLines	Gets or sets the CreateFromLines parameter.
	parmDatasourceRecordsPacked	Gets or sets the DatasourceRecordsPacked parameter.
	parmDocumentStatus	Gets or sets the DocumentStatus parameter.
	parmExecuteLateSelection	Gets or sets the ExecuteLateSelection parameter.
	parmForceUpdate_W	Gets or sets the ForceUpdate_W parameter.
	parmHistoryList	Gets or sets the HistoryList parameter.
	parmId	Gets the Id parameter.
	parmInterCompanyCompanyId	Gets or sets the InterCompanyCompanyId parameter.
	parmInterCompanyMap	Gets or sets the InterCompanyMap parameter.
	parmInterCompanyParmId	Gets or sets the InterCompanyParmId parameter.
	parmInterCompanyParmSelectFromJournal	Gets or sets the InterCompanyParmSelectFromJournal parameter.
	parmIsInBatch	Gets or sets the IsInBatch parameter.
	parmLedgerJournalTrans	Gets or sets the LedgerJournalTrans parameter.
	parmLineList	Gets or sets the LineList parameter.
	parmLineMapKey
	parmLineTableId	Gets the LineTableId parameter.
	parmMCRPickWaveReference	Gets or sets the pick wave reference.
	parmMultiForm	Gets or sets the MultiForm parameter.
	parmOnlyCreateParmUpdate	Gets or sets the OnlyCreateParmUpdate parameter.
	parmParmId	Gets or sets the ParmId parameter.
	parmParmIdSynched	Gets or sets the ParmIdSynched parameter.
	parmParmTable_W	Gets or sets the ParmTable_W parameter.
	parmParmUpdate	Gets or sets the ParmUpdate parameter.
	parmParmUpdateSysLastValue	Gets or sets the ParmUpdateSysLastValue parameter.
	parmProforma	Gets or sets the Proforma parameter.
	parmQueryChooseLines	Gets or sets the QueryChooseLines parameter.
	parmShowQueryForm	Gets or sets the ShowQueryForm parameter.
	parmSourceTable	Gets or sets the SourceTable parameter.
	parmSubTableMapKey	Generates a key for the specified record.
	parmSubTableTableId	Gets the SubTableTableId parameter.
	parmTableMapKey
	parmTableTableId	Gets the TableTableId parameter.
	parmTransDate	Gets or sets the TransDate parameter.
	parmUsePackedMapInChooseLinesQuery	Gets or sets the UsePackedMapInChooseLinesQuery parameter.
	parmVersioningStrategy	Gets or sets the VersioningStrategy parameter.
	parmWasQueryFormCancelled	Gets or sets the WasQueryFormCancelled parameter.
	pdsCWInterCompanyParmLineQty
	processAdditional	Overrides method to support processing of additional lines in parameter tables that were used by the purchase invoice.
	promptChooseLines	Executes the prompt of the ChooseLines query on the client-side if the class is currently running on the server.
	queryName	Gets the name of the query that is used to create data.
	reArrange	Performs a re-arrange of the created data.
	reArrangeEnd	Called when the re-arrange of data is completed.
	reArrangeInit	Initializes the re-arrange process.
	reArrangeLines	Re-arranges the record in the line posting parameter table.
	reArrangeQueryRun	Gets the QueryRun that is used in the re-arrange process.
	reArrangeSplit	Performs a split of the re-arranged data.
	recIdSuspensionTables	Gets a List of tables that should have suspended Record ID generation.
	removeRecIdSuspension	Removes a Record ID suspension.
	reSelect	Performs a re-select of the created data.
	reSelectEnd	Called when the re-selection of data is completed.
	reSelectInit	Initializes the re-select process.
	reSelectLine	Creates a parameter line record during reselect, depending on whether journal transactions can be posted.
	reSelectLines	Re-selects the record in the line posting parameter table.
	reselectSummaryPackingSlip_W	Is a stub method that rereads a packing slip record.
	selectChooseLines	Executes either the formletterParmData.doChooseLinesFromLine method or the formletterParmData.doChooseLines method.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	skipMayJournalBePosted	Determines whether to make the call to the formletterParmData.mayJournalBePosted method when data is created.
	sourceLineTableId	Gets the table ID for the source line table.
	sourceTableChanged	Indicates whenever the source table is changed.
	sourceTableTableId	Gets the table ID for the source table.
	splitInventOwnerId_RU	Determines whether splitting of the posting parameter lines by inventory owner ID is supported.
	splitInventProfileType_RU	Determines whether splitting of the posting parameter lines by inventory profile type is supported.
	splitPostingProfile_RU	Determines whether splitting of the posting parameter lines by inventory profile is supported.
	suspendRecIds	Suspends record ID generation.
	tableRefIdUsed	Gets or sets a Boolean value that indicates whether the current table reference ID is used.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	updateParmTableSplit	Updates the posting parameter header record according to the split settings.
	updateQueryBuild	Updates the query that is used during data creation.
	updateQueryDocumentRanges	Adds ranges on order ID to the query that is used when data is created.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	useLateSelectionQuery	Indicates whether to use the last selection query.
	useSplitting	Determines whether splitting of the posting parameter lines is supported.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::getNewParmId	Gets a new parameter ID.
	::getNewTableRefId	Gets a new table reference ID.
	::numRefParmId	Gets the NumberSequenceReference object for the parameter ID.
	::promptChooseLinesOnClient	Displays the chooseLines prompt on the client.

Top

Inheritance Hierarchy

Object Class
  formletterParmData Class
    ProjFormletterParmData Class
    PurchFormletterParmData Class
    PurchRFQFormletterParmData Class
    SalesFormletterParmData Class