QuickObjects.ObjectBase Send comments on this topic.
BaseField Class Members
See Also  Fields  Properties  Methods 
Akal.QuickObjects.ObjectBase Namespace : BaseField Class


The following tables list the members exposed by BaseField.

Public Constructors

 NameDescription
Public ConstructorBaseField ConstructorOverloaded. BaseField

Default constructor for BaseField class.  

Top

Protected Fields

 NameDescription
Protected Field_operator

_operator

_operator has been marked as protected just to allow the inheriting classes the ability to change the operator without going through the property set method, which will reset the UseInSearch flag.


		this._operator = " IN ";
		

Or


		this._operator = " = ";
		
 
Top

Public Properties

 NameDescription
Public PropertyAllowGroupByAllowGroupBy

Holds a Boolean value that can be used for specifying weather this field can be used in grouped result set or not.

 
Public PropertyAllowNullAllowNull

Holds a Boolean value that can be used for specifying weather this field can contain Null values.  

Public PropertyAllowSaveAllowSave

Holds a Boolean value that can be used for specifying weather this field can be used in updates/inserts or not.

This value doesn't necessarily indicate that the field will be used in the updates/inserts, but if this is true, only then the field's UseInSave property will be used.

This can be useful to the User Interface controls to be able to decide if this field will allow updates or not.  

Public PropertyAllowSearchAllowSearch

Holds a Boolean value that can be used for specifying weather this field can be used in searching resultset or not.

This value doesn't necessarily indicate that the field will be used in the Search criteria, but if this is true, only then the field's UseInSearch property will be used.

This can be useful to the User Interface controls to be able to decide if this field will allow search or not.  

Public PropertyAllowSortAllowSort

Holds a Boolean value that can be used for specifying weather this field can contain Null values.

This value doesn't necessarily indicate that the field will be used in the sort, but if this is true, only then the field's Sort property will be used.

This can be useful to the User Interface controls to be able to decide if this field will allow sorting or not.  

Public PropertyBusinessObjectBusinessObject

Holds a reference to the business object that contains this field.  

Public PropertyDBTypeDBType

Returns a Type representation of the .NET type that is equivalent to the underlying database type.  

Public PropertyGroupPositionGroupPosition

GroupPosition can be used to specify the position of the column in the group by clause.  

Public PropertyGroupTypeGroupType

Determines weather a field will be used in group by clause and the aggregate function to use (if any).  

Public PropertyIsCustom

IsCustom

Holds a Boolean value that can be used for specifying weather this field's name is a custom name or not.

If it is set to true the Name property can be assigned any valid sql String. This can be very useful for creating calculated columns in result sets where the calculated column is created by the database server.


	MyField.IsCustom = true;
	
 
Public PropertyIsDirtyIsDirty

Holds a Boolean value that can be used for checking if the value of this field has been modified since the business object values were loaded last.  

Public PropertyIsNullIsNull

Holds a Boolean value that can be used for specifying weather this field's current value is Null or not.

When IsNull is set to True the Value is destroyed.  

Public PropertyIsValid Returns a Boolean value indicating the status of all the validators applied to this field.  
Public PropertyListList

List can be used to specify a list of values that are to be used in the search criteria.

This is only used if the SearchMode is set to List or All.  

Public PropertyNameName

Holds this field's actual column name from the database.  

Public PropertyOperator

Operator

Holds a String value that can be used for specifying search operator. Changing the Operator value also set ths UseInSearch property to true. NOTE: Starting version 3.x you can use Operators class that provides constants for each operator that is implemented.


	MyField.Operator = Operators.EqualTo;
	

OR


	MyField.Operator = Operators.NotEqualTo;
	

OR


	MyField.Operator = Operators.Like;
	
 
Public PropertyOriginalValue OriginalValue is used to keep track of the original value loaded from the database during Load operation. This value is used for concurrency checking during an Update or Delete method.  
Public PropertyResultSetNameResultSetName

Holds a String value that can be used for specifying the result set name (i.e. an alias) for this column.

 

Public PropertySearchCondition

SearchCondition

Holds a String value that can be used for specifying search condition.

You can use MoreResults property of the business object and that will automatically assign a value to the SearchCondition property. However, by directly changing the value of this property you gain full control over the search critiria.


	MyField.SearchCondition = " AND ";
	

OR


	MyField.SearchCondition = " OR ";
	
 
Public PropertySearchModeSearchMode

SearchMode is used to determine weather the field's where clause will be based on the value, list or all.  

Public PropertySearchPostfix

SearchPostfix

Holds a String value that can be used as postfix to the search criteria for this field.


	MyField.SearchPostfix = " ) ";
	
 
Public PropertySearchPrefix

SearchPrefix

Holds a String value that can be used as prefix to the search criteria for this field.


	MyField.SearchPrefix = " (  ";
	
 
Public PropertySortSort

Determines weather a field will be used in sort and its sort direction.  

Public PropertySortPositionSortPosition

SortPosition can be used to specify the position of the column in the sort order.  

Public PropertySqlParamSqlParam

Holds a IDataParameter value that can be used for specifying the SqlParameter Name.

SqlParam is not serialized and it is also ignored by the xml serialization.

In normal circumstances, there is no need to assign value to this property as it automatically handles it.  

Public PropertyTableNameTableName

Holds a String value that can be used for specifying the table name for this field.  

Public PropertyTableResultSetNameTableResultSetName

Holds a String value that can be used for specifying the table's result set name for this field.

This should match with the value of the business objects ResultSetName property.

In normal circumstances, there is no need to assign value to this property as it automatically handles it.  

Public PropertyUseInSaveUseInSave

Holds a Boolean value that can be used for specifying weather to include this field in specifying the update command.  

Public PropertyUseInSearchUseInSearch

Holds a Boolean value that can be used for specifying weather to include this field in specifying the search criteria.  

Public PropertyValidators Collection of all the validators to be applied to this field during validation.  
Public PropertyValueValue

Place holder object for the Value, this should be overridden by each inheriting field.  

Public PropertyVisibleVisible

Holds a Boolean value that can be used for specifying weather to include this field in resulting dataset or not.  

Top

Public Methods

 NameDescription
Public MethodAssignValueToParamOverloaded. AssignValueToParam

It assigns currently stored values to database parameter object in SqlParam.

Parameters:
Description
queryType
 

Public MethodCopyOverloaded.  Copy - This method simply copies all the property values into the passed in instance.  
Public MethodCopyValidators CopyValidators - Can be used to copy all the validators for a Field instance to another Field instance. The FieldToValidate properties are automatically updated to reflect the new instance. Note: This does not provide "true" copy, it only moves the references.  
Public MethodGetFieldTypeGetFieldType

It returns the System.Type with this field type.

Returns:
Type
System.Type
 

Public MethodGetInsertExpressionGetInsertExpression

It returns the value assignment String for this field to be used in an insert statement.

Parameters:
Description
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
 

Public MethodGetListWhereExpressionGetListWhereExpression

It creates the where clause for the List field of each field.

Parameters:
Description
includeTableNameThis indicates wheather the table name wil be prefixed to the column name.
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
 

Public MethodGetOriginalWhereExpressionGetWhereExpression

It creates the where clause based on search settings of each field.

Parameters:
Description
includeTableNameThis indicates wheather the table name wil be prefixed to the column name.
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
 

Public MethodGetResultSetNameGetResultSetName

GetResultSetName compares the Name property with ResultSetName property and returns ResultSetName if it is different from Name property.

Returns:
Type
System.String
 

Public MethodGetSortExpressionGetSortExpression

It returns a String if the Sort is set to either Ascending or Descending SortTypes value. If Sort is set to None then a blank value is returned.

Returns:
Type
System.String
 

Public MethodGetSqlParamNameGetSqlParamName

It returns a value that represents a parameter name appropriate for the selected database type. In normal situations it is needed to call this method as all the parameter handeling is done by business objects.

Parameters:
Description
includeTableNameThis indicates wheather the table name wil be prefixed to the column name.
prefixValue will be prefixed with the parameter name.
countUsed to ensure that all parameter names are unique.

Returns:
Type
System.String
 

Public MethodGetSqlParamName_OrigOverloaded. GetSqlParamName

It returns a value that represents a parameter name appropriate for the selected database type. In normal situations it is needed to call this method as all the parameter handeling is done by business objects.

Parameters:
Description
includeTableNameThis indicates wheather the table name wil be prefixed to the column name..

Returns:
Type
System.String
 

Public MethodGetUpdateExpressionGetUpdateExpression

It returns the value assignment String for this field.

Parameters:
Description
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
 

Public MethodGetValueExpressionGetValueExpression

GetValueExpression does not provide any functionality but unctionality is provided by each type of field class as each field class overwrites this function.

Returns:
Type
System.String
 

Public MethodGetWhereExpressionOverloaded. GetWhereExpression

It creates the where clause based on search settings of each field.

Parameters:
Description
includeTableNameThis indicates wheather the table name wil be prefixed to the column name.
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
 

Public MethodParseParse

It doesnot provide any functionality at this level. It is implemented by each field type.

Parameters:
Description
strValue
 

Public MethodSetSqlParamTypeSetSqlParamType

It is implemented by each field type class.

Parameters:
Description
param
 

Public MethodValidate Validates all the validators applied to this field, and returns false if any of the validators fail.  
Top

See Also