QuickObjects.ObjectBase Send comments on this topic.
GetFieldsList Method
See Also 
Akal.QuickObjects.ObjectBase Namespace > BaseBusinessObject Class : GetFieldsList Method

GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

NOTE: If the IncludeTableName property of this or any joined object is set to true, that business object's field names will be prefixed with their table name.

Parameters:
Description
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String

Overload List

OverloadDescription
GetFieldsList(Int32,Int32,IBusinessObjectCollection)GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

NOTE: If the IncludeTableName property of this or any joined object is set to true, that business object's field names will be prefixed with their table name.

Parameters:
Description
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String
 

GetFieldsList(Boolean,Int32,Int32,IBusinessObjectCollection)GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

Parameters:
Description
includeTableNameIf true then each field name will be have its table name prefixed. This is important and useful when creating where expression from multiple tables and more than one table may contain the same column name.
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String
 

GetFieldsList(Boolean,RecursionTypes,Int32,Int32,IBusinessObjectCollection)GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

Parameters:
Description
includeTableNameIf true then each field name will be have its table name prefixed. This is important and useful when creating where expression from multiple tables and more than one table may contain the same column name.
recurRecursion type that will determine what kind of joined objects will be covered. If Recursion is set to RecursionTypes.Parent then only the Join objects with relationship type of Parent will be covered and hence same process for Child relationship.
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String
 

GetFieldsList(Boolean,RecursionTypes,Boolean,Int32,Int32,IBusinessObjectCollection)GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

Parameters:
Description
includeTableNameIf true then each field name will be have its table name prefixed. This is important and useful when creating where expression from multiple tables and more than one table may contain the same column name.
recurRecursion type that will determine what kind of joined objects will be covered. If Recursion is set to RecursionTypes.Parent then only the Join objects with relationship type of Parent will be covered and hence same process for Child relationship.
includeTableNameIf true then each field name will be have its ResultSetName post fixed. This is important and useful when you need to have a field appear with its alias in the result set.
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String
 

GetFieldsList(Boolean,RecursionTypes,Boolean,Boolean,Int32,Int32,IBusinessObjectCollection)GetFieldsList

Provides a String of field names separated by a comma for this object and any joined objects. The Recursive property on this objects and on the joined objects determine if the joined objects will also try to create a field list from their joined objects to be included in this field list. This process will follow until the depth reaches maxLevel parameter value.

Parameters:
Description
includeTableNameIf true then each field name will be have its table name prefixed. This is important and useful when creating where expression from multiple tables and more than one table may contain the same column name.
recurRecursion type that will determine what kind of joined objects will be covered. If Recursion is set to RecursionTypes.Parent then only the Join objects with relationship type of Parent will be covered and hence same process for Child relationship.
includeTableNameIf true then each field name will be have its ResultSetName post fixed. This is important and useful when you need to have a field appear with its alias in the result set.
useVisibilityIf true then each field name will only be included only if it is either set to visible or its AllowSave and UseInSave are true. If you need to create a field list for an insert statement pass a false value, otherwise for a select statement use true.
levelCurrent level in recursion.
maxLevelsMaximum levels of business objects to cover during recursion.
objectsCoveredA collection that can be used to track what business objects are already covered.

Returns:
Type
System.String
 

Requirements

Target Platforms: .NET Framework 1.1 or .NET Framework 2.0

See Also