SysQueryForm Class [AX 2012]

The SysQueryForm class is used by the advanced filter form for creating and manipulating query, sorting, and company ranges.

Syntax

class SysQueryForm

Run On

Client

Methods

	Method	Description
	addIndexFields
	addQFReplacement	Adds an appropriate query filter to the appropriate replacement field.
	addQueryIndex
	addRelativeQueryBuildDataSource	Adds the expected QueryDataSouceBinding to the DataSourceManager map.
	allowAddAndDelete
	allowAddDataSource
	allowAddRange
	allowAddSorting
	allowDataAreaIdField	Indicates whether it is valid to allow the DataAreaId field in the current operation.
	allowEdit
	allowSave
	allowsCompanyRange	Indicates whether the CompanyRanges tab is enabled.
	allowsValidTimeRanges	Determines whether the date effective tab is enabled.
	buildAggregate	Builds the list of existing aggregate clauses on the query and puts in a TmpSysQuery temporary table.
	buildAllFields	Builds the list of all the fields from the table in the specified data source.
	buildCompanyRanges	Builds the CompanyRanges temporary table from the ranges on the current query.
	buildDataSourceTree
	buildDataSourceTreeChild
	buildDataSourceTreeChildren
	buildDisabledDataSourceSet
	buildDisabledDataSourceSetChildren
	buildGroupBy	Builds the list of existing group-by fields on the query and puts in a TmpSysQuery temporary table.
	buildGroupByDataSourceSet
	buildHaving	Builds the list of existing clauses on the query and stores it in the TmpSysQuery table.
	buildImplicitReplacementsFromTable
	buildImplicitSurrogateFKReplacements	Builds surrogate foreign key replacement field as acting on the foreign key field that has the replacement field extension.
	buildNoFieldsDataSourceSet
	buildOrderByField	Insert data into sorting grid based on current QueryBuildDataSource object and field.
	buildQueryFields	Builds a list of fields on which a filter can be applied.
	buildQueryFilter	Builds the list of existing ranges on the query and puts it in a temporary table TmpSysQuery
	buildRange	Builds the list of existing ranges on the query and puts it in a TmpSysQuery temporary table.
	buildSavedQueriesBox
	buildSavedQueriesMap
	buildSorting
	buildSortOrderField	Starts building a sort order field based on data set on the current pointer of Sort Grid.
	buildSortOrderFieldSFKReplacement	Applies a sort on a surrogate FK field
	buildValidTimeRanges	Builds the list of existing valid time ranges on the query and puts it in a TmpSysQuery temporary table.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	caption
	changeCursorPrefixId	Sets the prefix ID and resets the field if it is selected.
	clearAggregateFields	Clear all aggregate fields
	dataSourceEdit
	dataSourceLoad
	dataSourcesLoad
	elementNameNoPrefix
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	expandSortIndex
	fieldInsertAggregate
	fieldInsertRange
	fieldInsertSorting
	fieldIsVisible
	fieldPackQueryFilter	Supports implicit surrogate FK replacements and stores information into the TmpSysQuerytable.
	getAllFields
	getAllTables
	getCurrentJoinMode	Retrieves the current joinMode of the current selected pointer.
	getDataAreaIdFieldId	Returns the ID for the DataAreaId field.
	getDataSourceLabel	Retrieves the label for the input data source.
	getDataSourceManager
	getDateEffectiveTable	Gets the date effective table in the query.
	getDateEffectiveType	Gets the date effective type in the query.
	getFieldFromFilter	Finds the actual dictField that represents the current field including a derived field, supports downward chain lookup.
	getHiddenFields
	getMatchingDimensionOrderByFields
	getMatchingOrderByField	Get order by field from a matching query data source and field.
	getOrderByFieldsWithMatchingDataSource	Find a list of orderByField list that matches the current data source.
	getPartitionFieldId	Returns the field ID for the Partition field.
	getRangeAutoHeader
	getRangeDataSource
	getRangeLabel
	getRangeNextUniqueId
	getRangeVisible	Gets the range visibility based on its range status, (OPEN/LOCK/HIDDEN), and its relationship to the QueryFilter object and join mode.
	getReferencedDataSourceSet
	getRelativeQueryBuildDataSource	Gets the relative QueryBuildDataSource object by the foreign query build data source and its relative field binding.
	getRelativeQueryBuildDataSources	Gets the map that is used to keep track of the expected QueryBuildDataSource objects in the query key.
	getReplacementFieldList	Gets the surrogate foreign key field and all its replacements that includes all the possible SFK fields that are deriving from derived tables of current QueryBuildDataSource object.
	getSelectedDataSource
	getSelectedPrefix
	getSelectedRecord
	getSelectedTable
	getSortingNo
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	getUnionRestrictedStatus	Finds the most restricted range status among all the queries that are applied on the current field
	getV25SaveName
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasAggregateApplied	Determine if a aggregate field is already inserted in the aggreagate grid
	hasExplitcitRangeFilter	Indicates whether there is an explicit filter range in the current data source with which to start.
	hasFilterApplied	Indicates whether a field of a table has a QueryFilter object applied to it.
	hasFilteringReplacementField	Indicates whether a specified data source that has the replacement field which has the range or filter applied in the current query.
	hasGeneratedDesign
	hasGroupByDataSources
	hasQueryBuildRangeApplied	Determines whether a field of a table has a QueryBuildRange object applied to it.
	hasQueryFilter	Determines whether the QueryFilter object has been applied.
	hasQueryFilterApplied	Determines whether a field of a table has a QueryFilter object applied to it.
	hasQueryFilters	Determine whether QueryFilter objects have applied on the current query build data source.
	hasRange
	hasRangeApplied	Indicates whether a field of a table has a QueryBuildRange object applied to it.
	hasRelativeQueryBuildDataSource	Indicates whether a QueryBuildDataSource object already exists.
	hasReportTemplate
	havingClauseExists	Checks whether the having clause exists in the query.
	hideLookupFields	Hides the look-up field based on its join type, the most restricted range status, and its dimension property.
	hideRestrictedDimensionLookups	Hides a look-up field based on the most restricted range status of the QBR or QF that is applied on the field; when the field is also a dimension field, hides associated dimension fields based on the most restricted status.
	hideSurrogateFKReplacementsLookup	Hides the replacement look up fields based on a relationship of joint type and SFK.
	indexFieldHasFilter	Makes sure that there is an index field that has the query filter applied to it.
	indexFieldHasRange	Ensures that there is an index field that has a query build range applied to it.
	initDataSource
	initSurrogateFKReplacementLookupMap	Initializes all required QueryBuildDataSource object for the query and adds these to our QueryDataSource collection If the QueryBuildDataSource object does not exist, the query will add this data source automatically.
	isCompositeQuerySource
	isDataSourceValidForSFKReplacements	Indicates whether a reference data source is a valid data source for a query filter to be applied.
	isFieldValid
	isForm
	isImplicitQueryFilter	Determines whether a filter that belongs to our implicit query filter set by checking the querybuilddatasource object and fieldName value.
	isIndex	Determines whether a field is the index.
	isQueryBuildRangeAllowed	Checks to see whether a QueryBuildDataSource object can use a QueryBuildRange object.
	isQueryBuildRangeFilterable	Indicates whether a field of a table is filterable in the QueryBuildRange collection.
	isQueryFilterAllowed
	isQueryFilterDataSourceValid	Indicates whether a query data source can use a query filter.
	isQueryFilterFilterable	Determines whether a field of a table is filterable in the QueryFilter collection.
	isReferencedDataSource	Indicates whether a data source has been referenced.
	isReplacementField	Indicates whether a field is a replacement field.
	isReport
	isRunbase
	isValidFieldTypeForAggregate	Indicates whether a field type is valid for use in an aggregate function.
	isVisibleBasedOnMostRestrictedStatus	Determines whether to display a field based on the most restricted union of the queryfiltersand querybuildranges value that are applied on the field.
	lastValueDesignName
	lastValueElementName
	lastValueType
	loadLastUsedQuery
	loadQueryPack	Loads the packed query into the current query and form.
	modifySortPoisitions	Re-positions the order of the rows that appear in the Sorting grid.
	new	Initializes a new instance of the SysQueryForm 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.)
	packAggregate	Packs an aggregate field.
	packAggregates	Packs aggregate fields.
	packOrderByField	Packs the fields that have a sort applied of a Specified QueryBuildDataSource object.
	packOrderByFields	Packs all the fields that have a sort applied of a specified QueryBuildDataSource object.
	packOrderByTable	Packs all the fields that have a sort applied of a specified QueryBuildDataSource object based on table in the hierarchy.
	packQFReplacement	Packs a query filter replacement for a SFK.If the replacement field is a Record ID we must construct a look up container for the Record ID.
	packSFKOrderByReplacementField	Constructs a row in the sorting grid whose field is a surrogate foreign key.
	parmPrintGrandTotal	Gets or sets the PrintGrandTotal parameter.
	parmPrintOnlyTotals	Gets or sets the PrintOnlyTotals parameter.
	parmPrintRanges	Gets or sets the PrintRanges parameter.
	parmPrintRemoveRepeatedFooters	Gets or sets the PrintRemoveRepeatedFooters parameter.
	parmPrintRemoveRepeatedHeaders	Gets or sets the PrintRemoveRepeatedHeaders parameter.
	performLookupField	Opens a lookup of fields that can be filtered.
	performLookupFieldPrefix
	performLookupTable
	prefixLoad
	query
	queryActiveLabel
	queryBuild
	queryBuildAggregate	Builds the query from the specified aggregate table.
	queryBuildCompanyRange	Builds a query from the given CompanyRange table.
	queryBuildFKRecIdQueryFilterOnView_IN	When view is used in query, starts retrieving information from the RangeGrid and starts building the corresponding QueryFilter object for surrogate FK replacements.
	queryBuildGroupBy	Builds the query from the given group-by table.
	queryBuildHaving	Builds the query from the given having table.
	queryBuildQueryFilter
	queryBuildSorting	Builds a new query by using the sorting order by fields that is specified in the Sorting grid.
	queryBuildSurrogateFKReplacements	Starts retrieving information from the RangeGrid and starts to build the corresponding QueryFilter object for surrogate FK replacements.
	queryBuildValidTimeRanges	Builds the valid time ranges from the temporary table.
	queryDelete
	queryInit
	queryLastUsedLabel
	queryLoad
	queryNextUniqueId
	queryPack
	querySave
	queryUnpack
	queryUpdate
	queryValidate
	rangeAutoSelect
	reset
	resetSortingIndex
	resolveField	Sets the IsExtendedDimension and DimensionAttributeName fields in the TmpSysQuery record based on the FieldLabel value.
	runbase
	runBaseCheckCloseDialog
	saveQueryPrUser
	selectDataSource
	selectField
	selectionFieldExists	Indicates whether the selection field already exists on the data source.
	selectPrefix
	setQueryRunTimeout
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showAggregate
	showCompany	Determines whether the company tab is displayed on the query form.
	showHaving
	showQuerySelect
	showReset
	showSorting
	sortingMapId
	sortingNoAdd
	sortingNoArrange
	sortingNoUpdate
	startPopulatingSorting	Starts building a sorting grid by iterating all the data sources and inserts data row by row from the current query.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	userUpdate
	validateCompanyRanges	Validates the values in the TmpSysQueryCompanyRange temporary table.
	validateField
	validateFieldsForCompany
	validatePrefix
	validateTable
	validateValidTimeRanges
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::aggregateFunction2SelectionField	Converts the value from AggregateFunction enumeration type to SelectionField enumeration type.
	::crossCompanyFieldVisible	Checks whether a field is visible when accounting for companies selected in the cross company tab.
	::findFields
	::getFieldLabel	Builds the field label that represents a surrogate FK replacement.
	::getRelativeRecIdFieldBinding	Retrieves the relative record ID field binding for the current surrogate foreign key.
	::getRelativeRecIdFieldBindingOnView_IN	Retrieve relative RecID field binding for current surrogate FK on view
	::getRelativeRecIdFieldOnView_IN	Retrieve relative RecID field information for current surrogate FK on view
	::hasValidCountryCode
	::isPackVersion21
	::isPackVersionCurrent
	::isSFK	Indicates whether a field that belongs to a table or view is an SFK.
	::pack2ElementName
	::pack2UtilElementType
	::selectionField2AggregateFunction	Converts the value from the SelectionField enumeration type to the AggregateFunction enumeration type.

Top

Remarks

Some functions of this class are also used by the Enterprise Portal SysQueryWeb class when the webMode variable is true.

Note that some objects might be null Nothing nullptr unit a null reference (Nothing in Visual Basic) when in Web mode. Please check for either null Nothing nullptr unit a null reference (Nothing in Visual Basic) or not in Web mode when you add more functions for the client.

Inheritance Hierarchy

Object Class
  SysQueryForm Class