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


The following tables list the members exposed by IBusinessObject.

Public Properties

 NameDescription
 PropertyAddResultsToDataSetAddFindResultsToDataSet

Holds the boolean value indicating weather the find method will try to add/refresh the result set into the dataset.

 
 PropertyAffectedRecordsAffectedRecords

AffectedRecords holds an Int32 value that would reflect the number of records affected by a query.

 
 PropertyAutoEncloseObjectNamesAutoEncloseObjectNames

Holds a boolean value indicating weather the field and table names will be enclosed with [ ].

 
 PropertyAutoRecursionAutoRecursion

Holds a boolean value. This value indicates weather business object will auto set and pass the value of Recursive property to the joined objects.

 
 PropertyAutoSyncOnConnect AutoSyncOnConnect  
 PropertyCaseConversion CaseConversion  
 PropertyConcurrencyMode ConcurrencyMode  
 PropertyDBType DBType  
 PropertyErrorStringErrorString

Holds a String value. This value is used to store information about any error that might have occured while business object performed any database operations.

 
 PropertyFieldsFields

Holds a collection of IField type fields.

 
 PropertyHasChanges HasChanges  
 PropertyIncludeTableNameIncludeTableName

Holds a boolean value. This value indicates weather the query to run the search will prefix the table name to the field names.

 
 PropertyIsDirtyIsDirty

Holds a boolean value. This value indicates weather the record values loaded into the object's properties have been modified since then or not.


	if (this.IsDirty) 
	{ 
		//codeBlock 
	}
	

As in the above example, IsDirty property can be used to determine weather the record values loaded have been modified or not and IsDirty can be combined with IsLoaded to check if the record has been loaded or not.

 
 PropertyIsLoadedIsLoaded

Holds a boolean value. This value indicates weather the record values have been loaded into the object's properties.


if (this.IsLoaded) 
{ 
	//codeBlock 
}
	

As in the above example, IsLoaded property can be used to determine weather the record values have been loaded or not. Also it can be combined with the IsDirty property to see if the values have been changed since they were last loaded.

 
 PropertyIsValid IsValid  
 PropertyJoinsJoins

Holds a JoinCollection value. This value is used to indicate the joins with other business objects.

 
 PropertyLocalTimeZone LocalTimeZone  
 PropertyMaxRecordsmaxRecords

Holds an Int32 value. This value indicates the number of maximum rows the search will return. This is acheived by adding the TOP x in the SELECT statement. If this value is set to -1 (by default) all rows will be returned.

 
 PropertyMoreResultsMoreResults

Holds a boolean value. This value is used when searching for records to determine weather to use " AND " clause or " OR " clase between the criteria.


	MoreResults = true;
	

As in the above example, when searching for records more results will be return.

 
 PropertyObjectMode ObjectMode  
 PropertyObjectState ObjectState  
 PropertyOnlyDistinctOnlyDistinct

Holds a boolean value. This value indicates weather the search results will return only distinct rows. This is acheived by adding DISTINCT keyword to the select statement.

 
 PropertyPageSizePageSize

Holds an Int32 value. This combined with the startRowIndex property can be used to create a paged view of the result set.

 
 PropertyParameterPrefix ParameterPrefix  
 PropertyPartialTextMatchPartialTextMatch

Holds a boolean value. This value is used when searching for records to determine weather match the text columns with partial values or exact values.


	PartialTextMatch = true;
	

As in the above example, when searching for records any records that contain the text will be returned.

 
 PropertyPrimaryKeyFieldsPrimaryKeyFields

Holds a collection of IField type fields that make up the Primary key the business object's tables.

 
 PropertyRecursive Recursive  
 PropertyResultSetResultSet

Holds the DataSet for the result sets.

 
 PropertyResultSetNameResultSetName

Holds the NameField value that will be used by the find method to Add/Refresh the table in the dataSet.

 
 PropertyStartRowIndexStartRowIndex

Holds an Int32 value. This combined with the pageSize property can be used to create a paged view of the result set.

 
 PropertyTableNameTableName

Holds a NameField value. This value is used to indicate the table the object is based on.

 
 PropertyTranslateTimeZones TranslateTimeZones  
 PropertyUseNoLockUseNoLock

Holds a boolean value. This value indicates weather the select query will use the nolock clause or not.

 
 PropertyVisibleVisible

Holds a boolean value. This value indicates weather the search results will show the columns of this table. This value overrides all the Visible properties of columns of this table.

 
Top

Public Methods

 NameDescription
 MethodCount Count  
 MethodDelete Delete  
 MethodFind Find  
 MethodFindAndLoad FindAndLoad.  
 MethodGetFieldsListOverloaded.   
 MethodGetJoinExpressionOverloaded.   
 MethodGetNewParameterInstance GetNewParameterInstance  
 MethodGetResultSetName GetResultSetName compares the Name property with DisplayName property and returns DisplayName if it is different from Name property.  
 MethodGetSortExpressionOverloaded.   
 MethodGetWhereExpressionOverloaded.   
 MethodInitializeObject InitializeObject  
 MethodInsert Insert  
 MethodLoad Load  
 MethodLoadFromDataRow LoadFromDataRow  
 MethodLoadOriginalFromDataRow LoadOriginalFromDataRow  
 MethodLoadOriginalFromHashtable LoadOriginalFromHashtable  
 MethodMaximum Maximum  
 MethodMinimum Minimum  
 MethodSave Save  
 MethodSetSqlParamType SetSqlParamType  
 MethodUpdate Update  
 MethodUseAllFieldsForDisplayOverloaded.   
 MethodUseAllFieldsForSave UseAllFieldsForSave  
 MethodUseAllFieldsForSearchOverloaded.   
Top

Public Events

 NameDescription
 EventAfterDelete AfterDelete  
 EventAfterFind AfterFind  
 EventAfterInsert AfterInsert  
 EventAfterLoad AfterLoad  
 EventAfterUpdate AfterUpdate  
 EventBeforeDelete BeforeDelete  
 EventBeforeFind BeforeFind  
 EventBeforeInsert BeforeInsert  
 EventBeforeLoad BeforeLoad  
 EventBeforeUpdate BeforeUpdate  
 EventObjectDisposing ObjectDisposing  
 EventObjectInitialized ObjectInitialized  
Top

See Also