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


The following tables list the members exposed by BooleanField.

Public Constructors

 NameDescription
Public ConstructorBooleanField ConstructorOverloaded. BooleanField

It is default constructor for BooleanField.

It offers no functionality but it calls the baseField's default constructor.  

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 = " = ";
		
(Inherited from BaseField)
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.

(Inherited from BaseField)
Public PropertyAllowNullAllowNull

Holds a Boolean value that can be used for specifying weather this field can contain Null values. (Inherited from BaseField)

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. (Inherited from BaseField)

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. (Inherited from BaseField)

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. (Inherited from BaseField)

Public PropertyBusinessObjectBusinessObject

Holds a reference to the business object that contains this field. (Inherited from BaseField)

Public PropertyDBTypeDBType

Returns a Type representation of the .NET type that is equivalent to the underlying database type. (Inherited from BaseField)

Public PropertyFalseTextFalseText

This value will be considered equallent to false value.  

Public PropertyGroupPositionGroupPosition

GroupPosition can be used to specify the position of the column in the group by clause. (Inherited from BaseField)

Public PropertyGroupTypeGroupType

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

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;
	
(Inherited from BaseField)
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. (Inherited from BaseField)

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. (Inherited from BaseField)

Public PropertyIsValid Returns a Boolean value indicating the status of all the validators applied to this field. (Inherited from BaseField)
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. (Inherited from BaseField)

Public PropertyNameName

Holds this field's actual column name from the database. (Inherited from BaseField)

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;
	
(Inherited from BaseField)
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. (Inherited from BaseField)
Public PropertyResultSetNameResultSetName

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

(Inherited from BaseField)

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 ";
	
(Inherited from BaseField)
Public PropertySearchModeSearchMode

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

Public PropertySearchPostfix

SearchPostfix

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


	MyField.SearchPostfix = " ) ";
	
(Inherited from BaseField)
Public PropertySearchPrefix

SearchPrefix

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


	MyField.SearchPrefix = " (  ";
	
(Inherited from BaseField)
Public PropertySortSort

Determines weather a field will be used in sort and its sort direction. (Inherited from BaseField)

Public PropertySortPositionSortPosition

SortPosition can be used to specify the position of the column in the sort order. (Inherited from BaseField)

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. (Inherited from BaseField)

Public PropertyTableNameTableName

Holds a String value that can be used for specifying the table name for this field. (Inherited from BaseField)

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. (Inherited from BaseField)

Public PropertyTrueTextTrueText

This value will be considered equallent to true value.  

Public PropertyUseInSaveUseInSave

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

Public PropertyUseInSearchUseInSearch

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

Public PropertyUseTextValueUseTextValue

This property if the TrueText and FalseText properties will be used instead of the regular True and False.  

Public PropertyUseTextValuesFor UseTextValuesFor is used to define the database types for the text values will be used instead of the boolean. This by default includes the Oracle database types, since there is no Boolean field directly available in Oracle. However, if you want to exten the automatic conversion of Text Value to Boolean and vise versa for any other database type you can add those database types here.  
Public PropertyValidators Collection of all the validators to be applied to this field during validation. (Inherited from BaseField)
Public PropertyValueValue

It holds a Boolean value.  

Public PropertyVisibleVisible

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

Top

Public Methods

 NameDescription
Public MethodAssignValueToParamOverloaded. Overridden. AssignValueToParam

Assigns the Value of this field into the database parameter passed in.

Parameters:
Description
queryType
param
 

Public MethodCopyOverloaded. Overridden.  Copy - Copies all property values from the current instance to 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. (Inherited from BaseField)
Public MethodGetFieldTypeOverridden. GetFieldType

Retuns a Type representation of System.Boolean

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
(Inherited from BaseField)

Public MethodGetIntGetInt

If the Value is set to true, this method returns 1. For false return 0, and for null value returns 0 as well.  

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
(Inherited from BaseField)

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
(Inherited from BaseField)

Public MethodGetResultSetNameGetResultSetName

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

Returns:
Type
System.String
(Inherited from BaseField)

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
(Inherited from BaseField)

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
(Inherited from BaseField)

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
(Inherited from BaseField)

Public MethodGetTextGetText

This returns TrueText property value if the value property is set to true, otherwise it returns FalseText.  

Public MethodGetUpdateExpressionGetUpdateExpression

It returns the value assignment String for this field.

Parameters:
Description
sqlParamsThis array contains all the parameter objects .

Returns:
Type
System.String
(Inherited from BaseField)

Public MethodGetValueExpressionOverridden. GetValueExpression

It returns the value assignment String for this field.

If the IsNull is set to true then "NULL" String value is returned. If however UseTextValue is true then TrueText or FalseText value is returned depending on weather Value is set to true or false. Otherwise "1" is returned if Value is true or "0" if Value is false.

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
(Inherited from BaseField)

Public MethodParseOverridden. Parse

It will take the String parameter value and if the UseTextValue is true, then the SetFromText will be called, otherwise a boolean value will be parsed from the strValue.

If the passed in value is null or empty it will set the IsNull property to true.

Parameters:
Description
strValue
 

Public MethodSetFromTextSetFromText

If the value of textValue parameter matches the TrueText property, the value property is set to true, otherwise it is set to false.

Parameters:
Description
textValue
 

Public MethodSetSqlParamTypeOverridden. SetSqlParamType

If UseTextValue is true then the DbType.String is set else it sets the DbType property of the database parameter with DbType.Boolean.

Parameters:
Description
param
 

Public MethodToStringOverridden. ToString

If UseTextValue is set to true the TrueText or FalseText value is returned depending weather the Value is true or false. If UseTextValue is not true then the function returns the String version of Value.

Returns:
Type
System.String
 

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

Public Operators

Public Operator Implicit Type Conversion Overloaded. Boolean

This allows the developer to directly get the value of this field as Boolean.

Parameters:
Description
fldBooleanField to convert

Top

See Also