QuickObjects.ObjectBase Assembly contains all the classes that make up the QuickObjects Business Logic Framework. QuickObjects Framework provides a very robust and powerful platform for you to build your own business logic layer.
Since, ObjectBase extends the functionality offered by the DBLibrary the ObjectBase assembly can be used to create business logic classes that can connect to any of the databases supported by the DBLibrary. ObjectBase in addition provides classes that provide very flexible and time tested solution to the everyday problems faced by database application developers using the .NET framework.
Classes
| Class | Description |
|---|---|
| AfterCommandEventArgs | AfterCommandEventArgs is used as the container for all events that are fired by the business object after a command is executed. |
| BaseBusinessObject | BaseBusinessObject Class Provides all the basic functionality needed by a business logic layer to communicate with a database to read/write and search for data. BaseBusinessObject makes it very simple for the developer to create their own business logic classes that extend the BaseBusinessObject and utilize the extensive features of QuickObjects framework. BaseBusinessObject and other QuickObjects framework classes together provide a robust and easy to implement database independent business logic layer. By extending BaseBusinessObject your business logic classes can utilize many built in features such as:
|
| BaseBusinessObjectCollection | BaseBusinessObjectCollection - This collection class is used to provide
enumeration over search results. This collection returns a loaded
BaseBusinessObject reference for each corrosponding row in the dataset. This
collection provides a high performance mechanism to iterate over search results.
This collection does not require multiple copies of the business objects, and it
uses the same business object to dynamically load values on demand and this reduces
the memory footprint by many times. For example, if the result set contained 500
records, this collection will not have 500 instances of the business objects,
instead use just one business object instance to dynamically load values. NOTE: This collection is not xml serializable, and hence is not available remotely via web services. |
| BaseBusinessObjectCollectionEnumerator | BaseBusinessObjectCollectionEnumerator - This enumrator is used to traverse over a result set. A single instance of the business object is used to load values dynamically as a particular position is accessed. This helps in keeping the memory footprint low and does not require a result set to be represented in multiple object instances. For example, if you result set contains 500 rows the result set is not represented by 500 instances of the business objects, and rather a smart loading technique is used. The smart loading technique used avoids duplicate memory usage and still provides easy access to each row of the result set using the object instance. |
| BaseEventArgs | BaseEventArgs class is used as the base class to hold all the event arguments used by all types of events of the Business Objects. |
| BaseField | BaseField Class BaseField is the class to be used as the basis for defining all data field classes. BaseField implements IField interface. NOTE: BaseField class should not be used directly in the user code. Only the classes that implement other data types and derive from this BaseField class should be used. |
| BaseFieldValidator | Base class that will provide the basic field validation such as check for Null values when the field does not allow Null. |
| BaseFieldValidatorCollection | BaseFieldValidatorCollection |
| BeforeCommandEventArgs | BeforeCommandEventArgs is used as the container for all events that are fired by the business object before a command is being executed. |
| BinaryField | BinaryField Class It extends baseField and is meant to store binary data in the form of array of bytes. |
| BinaryFieldTypeConverter | BinaryFieldTypeConverter - This class provides conversion capability between a Byte[] and BinaryField |
| BooleanField | BooleanField Class It extends baseField and is meant to store boolean value. |
| BooleanFieldTypeConverter | BooleanFieldTypeConverter - This class provides conversion capability between a Boolean and BooleanField |
| ByteField | ByteField Class It extends NumericField and is meant to store Byte value. |
| ByteFieldTypeConverter | ByteFieldTypeConverter - This class provides conversion capability between a Byte and ByteField |
| CompareFieldValidator | CompareFieldValidator will provide the field validation where a Field value must be compared to the value of another field. |
| DateTimeField | DateTimeField Class It extends baseField and is meant to store DateTime value. |
| DateTimeFieldTypeConverter | DateTimeFieldTypeConverter - This class provides conversion capability between a DateTime and DateTimeField |
| DecimalField | DecimalField Class It extends NumericField and is meant to store Decimal value. |
| DecimalFieldTypeConverter | DecimalFieldTypeConverter - This class provides conversion capability between a Decimal and DecimalField |
| DoubleField | DoubleField Class It extends NumericField and is meant to store Double value. |
| DoubleFieldTypeConverter | DoubleFieldTypeConverter - This class provides conversion capability between a Double and DoubleField |
| GuidField | GuidField Class It extends baseField and is meant to store Guid value. |
| GuidFieldTypeConverter | GuidFieldTypeConverter - This class provides conversion capability between a Guid and GuidField |
| IBusinessObjectCollection | IBusinessObjectCollection |
| IFieldCollection | IFieldCollection |
| Int16Field | Int16Field Class It extends baseField and is meant to store Int16 value. |
| Int16FieldTypeConverter | Int16FieldTypeConverter - This class provides conversion capability between a Int16 and Int16Field |
| Int32Field | Int32Field Class It extends NumericField and is meant to store Int32 value. |
| Int32FieldTypeConverter | Int32FieldTypeConverter - This class provides conversion capability between a Int32 and Int32Field |
| Int64Field | Int64Field Class It extends NumericField and is meant to store Int64 value. |
| Int64FieldTypeConverter | Int64FieldTypeConverter - This class provides conversion capability between a Int64 and Int64Field |
| Join | Join Class Provides the basis for creating a join between different business objects. |
| JoinCollection | JoinCollection |
| JoinField | JoinField Class Holds two fields used to indicate left and right fields in a join. |
| JoinFieldCollection | JoinFieldsCollection |
| ListField | ListField Class ListField class extends BaseField and is used to store a list of field values of any type. |
| NameField | NameField Class Provides the basis storing object name and helper functions for transforming the name. |
| NumericField | NumericField Class It extends baseField and is extended by each variation of numeric type. |
| ObjectBaseLicenseManager | |
| ObjectEventArgs | ObjectEventArgs is used as the container for all Object initialization and dispose related events. |
| Operators | Operators class provides an easy way to access various types of Operator values. |
| OriginalField | OriginalField - This field contains the original value loaded from the database. This is used in performing concurrency checks on Update and Delete commands. |
| RangeFieldValidator | RangeFieldValidator will provide the field validation where a Field value must be within a certain range. |
| RegularExpressionFieldValidator | RegularExpressionFieldValidator will provide the field validation where a Field value must match the regular expression provided. |
| RequiredFieldValidator | RequiredFieldValidator will provide the field validation where a Field value must be provided (even if the AllowNull property of the field is set to true). |
| SearchConditions | SearchConditions class provides an easy to access various types of SearchCondition values. |
| SearchGroup | SearchGroup Class It extends baseField and is meant to store a collection of fields that will be grouped together to build a search criteria. Note: This field is not included during XmlSerialization, this avoid circular references. Hence the ability to provide search groups remotely via web services interface will not be available. |
| SingleField | SingleField Class It extends NumericField and is meant to store Single value. |
| SingleFieldTypeConverter | SingleFieldTypeConverter - This class provides conversion capability between a Single and SingleField |
| StringField | StringField Class It extends baseField and is meant to store String value. |
| StringFieldTypeConverter | StringFieldTypeConverter - This class provides conversion capability between a String and StringField |
| TimeZonesFactory | |
| UInt16Field | UInt16Field Class It extends baseField and is meant to store UInt16 value. |
| UInt16FieldTypeConverter | UInt16FieldTypeConverter - This class provides conversion capability between a UInt16 and UInt16Field |
| UInt32Field | UInt32Field Class It extends NumericField and is meant to store UInt32 value. |
| UInt32FieldTypeConverter | UInt32FieldTypeConverter - This class provides conversion capability between a UInt32 and UInt32Field |
| UInt64Field | UInt64Field Class It extends NumericField and is meant to store UInt64 value. |
| UInt64FieldTypeConverter | UInt64FieldTypeConverter - This class provides conversion capability between a UInt64 and UInt64Field |
| Utilities | Utilities Class Provides helper functions. |
| XmlDocumentField | XmlDocumentField Class It extends baseField and is meant to store XmlDocument value. |
Interfaces
| Interface | Description |
|---|---|
| IBusinessObject | IBusinessObject provides the basis and defines the contract all business logic classes will need to implement. |
| IField | IField provides the basis and defines the contract all fields in a business logic class will need to implement. |
| IFieldValidator | IFieldValidator interface is to be used by all validators that will provide validation for any given field. |
Delegates
| Delegate | Description |
|---|---|
| AfterCommandEventHandler | AfterCommandEventHandler is used to describe the signature of events that will be fired by the Business Object after a command was executed. |
| BeforeCommandEventHandler | BeforeCommandEventHandler is used to describe the signature of events that will be fired by the Business Object prior to executing a command. |
| ObjectEventHandler | ObjectEventHandler Delegate is used to describe the event signature for all the Object Initialization and Dispose related events that will be fired by the Business Objects. |
Enumerations
| Enumeration | Description |
|---|---|
| CaseTypes | CaseTypes |
| CompareFieldValidator.ComparisonTypes | ComparisonTypes enumeration is used by the CompareFieldValidator to decide what type of comparison to perform while validating the field. |
| ConcurrencyModes | ConcurrencyModes |
| DateTimeFieldTypes | DateTimeFieldTypes |
| GroupByModes | GroupByTypes |
| GroupTypes | GroupTypes will be applied to each field. Each value will cause a certain function to be applied to the column while the business object's ObjectMode property is set to GroupBy. |
| JoinTypes | JoinTypes. |
| ObjectModes | ObjectModes - Values indicate what the object's intentions are, and the object's field's can take appropriate actions based on this value. |
| ObjectStates | ObjectStates - Values indicate if the object should connect to the database or should retain its inserts/updates/deletes for later syncronization. |
| PartialTextModes | PartialTextModes |
| ProductEditions | ProductEditions indicate what edition of the product is being used. |
| QueryTypes | QueryTypes - Various query types that the business object can perform against database. |
| RecursionTypes | RecusrionTypes - Defines various kinds of Recursions the object can be in. |
| RelationshipTypes | RelationshipTypes. |
| SearchModes | SearchModes |
| SortTypes | SortTypes. |
| ValidationModes | ValidationModes are used by the Validate method of the business object and field objects to determine the type of validation needed. |
| ValidatorTypes |
ValidatorTypes enum lists all the implemented validator types.
Note: If you implement a custom validator, that will not be included here. |
| XmlFieldStorageTypes | XmlFieldStorageTypes |