QuickObjects.ObjectBase Send comments on this topic.
IField Interface Members
See Also  Properties  Methods 
Akal.QuickObjects.ObjectBase Namespace : IField Interface


The following tables list the members exposed by IField.

Public Properties

 NameDescription
 PropertyAllowGroupByAllowGroupBy

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

 
 PropertyAllowNullAllowNull

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

 
 PropertyAllowSaveAllowSave

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

 
 PropertyAllowSearchAllowSearch

Holds a Boolean value that can be used for specifying weather this field can be used in search criteria of the resultset or not.

 
 PropertyAllowSortAllowSort

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

 
 PropertyBusinessObjectBusinessObject

Holds a IBusinessObject value that can be used for specifying the business object that contains the field object.

 
 PropertyDBTypeDBType

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

 PropertyGroupPosition GroupPosition can be used to specify the position of the column in the group by clause.  
 PropertyGroupType GroupTypes can be used to specify the group by mode for a column.  
 PropertyIsCustomIsCustom

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

 
 PropertyIsDirtyIsDirty

Holds a Boolean value that can be used for specifying weather this field value has been modified or not.

 
 PropertyIsNullIsNull

Holds a Boolean value that can be used for specifying weather this field is currently null or has a value.

 
 PropertyIsValid Each field implementing this interface will return a Boolean value indicating the status of all the validators.  
 PropertyListList

Holds list of values that can be used for searching.

 
 PropertyNameName

Holds a NameField value that can be used for specifying the table's column name.

 
 PropertyOperatorOperator

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

 
 PropertyOriginalValue OriginalValue contains the underlying value from the data store and can be used to build query criteria for updates or deletes if the concurrency is turned on.  
 PropertyResultSetNameResultSetName

Holds a NameField value that can be used for specifying the result set name for the table's column.

 
 PropertySearchConditionSearchCondition

Holds a String value that can be used for specifying search condition i.e. AND, OR in the where clause.

 
 PropertySearchPostfixSearchPostfix

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

 
 PropertySearchPrefixSearchPrefix

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

 
 PropertySort Sort can be used to specify the sort direction for the result set.  
 PropertySortPosition SortPosition can be used to specify the position of the column in the sort order.  
 PropertySqlParamSqlParam

Holds a IDataParameter that can be used for specifying the SqlParamater object.

 
 PropertyTableNameTableName

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

 
 PropertyTableResultSetNameTableResultSetName

Holds a NameField value that can be used for specifying the table's display name for this field.

 
 PropertyUseInSaveUseInSave

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

 
 PropertyUseInSearchUseInSearch

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

 
 PropertyValidators Contains a list of all the validators that will be applied to this field when the fields are being validated by the business object.  
 PropertyValueValue

Place holder object for the Value.

 
 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
 MethodAssignValueToParamOverloaded.   
 MethodCopyOverloaded.   
 MethodCopyValidators CopyValidators - Copies All Validators and updates their FieldToValidate properties.  
 MethodGetFieldType Returns a Type representation of each field's implemented Value type.  
 MethodGetInsertExpression GetInsertExpression will need to be implemented by each field class so that each field can implement its own custom ability to provide value lists including Parameters to the insert statement.  
 MethodGetOriginalWhereExpression GetOriginalWhereExpression will need to be implemented by each field class so that each field can implement its own custom ability to provide concurrency management.  
 MethodGetResultSetName GetResultSetName compares the Name property with DisplayName property and returns DisplayName if it is different from Name property.  
 MethodGetSortExpression GetSortExpression will need to be implemented by each field class so that each field can implement its own custom ability to provide list of fields to sort on.  
 MethodGetSqlParamName GetSqlParamName returns the name that can be used for the parameters passed into a query. A count of parameters is passed and is used to ensure that the parameter name is unique.  
 MethodGetUpdateExpression GetUpdateExpression will need to be implemented by each field class so that each field can implement its own custom ability to provide value assignment statement.  
 MethodGetValueExpression GetValueExpression will need to be implemented by each field class so that each field can implement its own custom ability to provide value lists.  
 MethodGetWhereExpressionOverloaded.   
 MethodParse Parse will be implemented by each field class to convert String data value into its specific type being implemented by the field class  
 MethodSetSqlParamType SetSqlParamType sets the DbType property with appropriate type for each field.  
Top

See Also