 | cDb |
Represents a cache of Vtrin class objects.
Inheritance HierarchySystemObject
ABB.VtrincDbClassInstanceCache
cDbClassInstanceCachecDbClass
cDbClassNamelessInstanceCacheString, cDbClass
ABB.VtrincDbClasses
ABB.VtrincDbClassInstanceCache
cDbClassInstanceCachecDbClass
cDbClassNamelessInstanceCacheString, cDbClass
ABB.VtrincDbClasses
Namespace: ABB.Vtrin
Assembly: VtrinLib (in VtrinLib.dll) Version: 530.2607.2220.0 (RTDB_main)
SyntaxThe cDbClasses type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | cDbClasses | Initializes a new instance of the cDbClasses class |
Properties| Name | Description | |
|---|---|---|
 | ACLEntries | (Inherited from cDbClassInstanceCache) |
| AllFetched |
Gets value telling if all instances have been fetched into cache.
(Inherited from cDbClassInstanceCache) |
| CanInherit | (Inherited from cDbClassInstanceCache) |
| Driver |
Database driver associated for this class collection.
(Inherited from cDbClassInstanceCache) |
| EffectiveGroup | (Inherited from cDbClassInstanceCache) |
| EffectiveGroupPermissions | (Inherited from cDbClassInstanceCache) |
| EffectiveOtherPermissions | (Inherited from cDbClassInstanceCache) |
| EffectiveOwner | (Inherited from cDbClassInstanceCache) |
| EffectiveOwnerPermissions | (Inherited from cDbClassInstanceCache) |
| ElementType | (Inherited from cDbClassInstanceCache) |
| Expression | (Inherited from cDbClassInstanceCache) |
| Group | (Inherited from cDbClassInstanceCache) |
| GroupPermissions | (Inherited from cDbClassInstanceCache) |
| ItemObject |
Gets class instance by id, returns null if instance is not found. Remember to call
Request before accessing multiple objects so that fetching can be optimized.
(Inherited from cDbClassInstanceCache) |
| ItemString |
Gets class instance by name, returns null if instance is not found. Remember to call
Request before accessing multiple objects so that fetching can be optimized.
Supported only for named types.
(Inherited from cDbClassInstanceCache) |
| OtherPermissions | (Inherited from cDbClassInstanceCache) |
| Owner | (Inherited from cDbClassInstanceCache) |
| OwnerPermissions | (Inherited from cDbClassInstanceCache) |
| Permissions | (Inherited from cDbClassInstanceCache) |
| Provider | (Inherited from cDbClassInstanceCache) |
| RequiredSecurityFlags | (Inherited from cDbClassInstanceCache) |
| RWLock |
Gets lock to use for synchronizing access to cache.
(Inherited from cDbClassInstanceCache) |
| SecurityChildren | (Inherited from cDbClassInstanceCache) |
| SecurityParent | (Inherited from cDbClassInstanceCache) |
| TypeName |
Gets typename of class instances in this cache (same as pOwner.pName).
(Inherited from cDbClassInstanceCache) |
Methods| Name | Description | |
|---|---|---|
| Add |
Create a new instance of this class. Note that this new class instance will not be
inserted to list of available classes before commiting.
(Inherited from cDbClassInstanceCache) |
| ClearCache |
Clears the cache, forcing reloading of the instances.
(Inherited from cDbClassInstanceCache) |
| CommitChanges(cDbClassInstance) |
Commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChanges(cDbClassInstance, Boolean) |
Commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChanges(cDbClassInstance, Boolean, Boolean) |
Commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChanges(cDbClassInstance, cDbClassInstance, Boolean, ActionObject) | (Inherited from cDbClassInstanceCache) |
| CommitChangesAsync(cDbClassInstance) |
Asynchronously commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChangesAsync(cDbClassInstance, Boolean) |
Asynchronously commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChangesAsync(cDbClassInstance, cDbClassInstance, Boolean) | (Inherited from cDbClassInstanceCache) |
| CommitChangesAsync(cDbClassInstance, Boolean, Boolean) |
Asynchronously commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChangesWithSecurityChecking(cDbClassInstance) |
Commits multiple created or changed instances to database.
(Inherited from cDbClassInstanceCache) |
| CommitChangesWithSecurityChecking(cDbClassInstance, cDbClassInstance) |
Commits multiple created or changed instances to database with security checks. Fails if any of the instances are missing required permissions
(Inherited from cDbClassInstanceCache) |
| CommitChangesWithSecurityChecking(cDbClassInstance, Boolean) |
Commits multiple created or changed instances to database with security checking.
(Inherited from cDbClassInstanceCache) |
| ContainsId |
Checks if instance with given id is contained in cache.
(Inherited from cDbClassInstanceCache) |
| Dispose | Releases all resources used by the cDbClasses (Overrides cDbClassNamelessInstanceCache.Dispose) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FillControl |
Fills a control with items of type contained in this cache. This is a legacy support
function for Windows Forms based Vtrin UI, do not use for anything else.
(Inherited from cDbClassInstanceCache) |
| GetCachedInstances |
Gets instances that are currently being cached as an array.
(Inherited from cDbClassInstanceCache) |
| GetFromCache(Object) |
Gets instance by id from cache if available, return null if not in cache. Will not try
to fetch from database.
(Inherited from cDbClassInstanceCache) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetInstanceById(Object) |
Gets instance by Id, same as this[object instanceid].
(Inherited from cDbClassInstanceCache) |
| GetInstanceById(Object, Boolean) |
Gets instance by Id, same as this[object instanceid]. Throws exception on error if throwonerr is true.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByIdAsync(Object) |
Asynchronously gets instance by Id.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByIdWithSecurityChecking(Object) |
Gets an instance by Id with security checking. Returns null if instance is not found, there is no read access or an error occured. This API is meant for
implementing servers only and requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call
will just add extra overhead.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByIdWithSecurityChecking(Object, Boolean) |
Gets an instance by Id with security checking. Throws exception on error if throwonerr is true. This API is meant for implementing servers only and
requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call will just add extra overhead.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByIdWithSecurityCheckingAsync(Object) |
Asynchronously gets instance by Id, same as this[object instanceid]. Returns null if instance is not found, there is no read access or an error occured.
This API is meant for implementing servers only and requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal
clients using this call will just add extra overhead.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByIdWithSecurityCheckingAsync(Object, Boolean) |
Asynchronously gets instance by Id. Throws exception on error if throwonerr is true. This API is meant for implementing servers only and
requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call will just add extra overhead.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByName(String) |
Gets instance by Name, same as this[string instancename]. If the class does not have a name property, the
call will be redirected to GetInstanceById.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByName(String, Boolean) |
Gets instance by Name. Throws exception on error if throwonerr is true. If the class does not have a name property, the
call will be redirected to GetInstanceById.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameAsync(String) |
Asynchronously gets instance by Name. If the class does not have a name property, the
call will be redirected to GetInstanceByIdAsync.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameAsync(String, Boolean) |
Gets instance by Name with security checking. Throws exception on error if throwonerr is true.
If the class does not have a name property, the call will be redirected to GetInstanceByIdAsync.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameWithSecurityChecking(String) |
Asynchronously gets instance by Name with security checking. This API is meant for implementing servers only and
requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call will just add extra overhead.
If the class does not have a name property, the call will be redirected to GetInstanceByIdWithSecurityChecking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameWithSecurityChecking(String, Boolean) |
Asynchronously gets instance by Name with security checking. Throws exception on error if throwonerr is true. This API is meant for implementing servers only and
requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call will just add extra overhead.
If the class does not have a name property, the call will be redirected to GetInstanceByIdWithSecurityChecking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameWithSecurityCheckingAsync(String) |
Asynchronously gets instance by Name. This API is meant for implementing servers only and
requires implementing / setting the driver.ActiveUser (UserProvider) to work properly. For normal clients using this call will just add extra overhead.
(Inherited from cDbClassInstanceCache) |
| GetInstanceByNameWithSecurityCheckingAsync(String, Boolean) |
Gets instance by Name with security checking. Throws exception on error if throwonerr is true.
(Inherited from cDbClassInstanceCache) |
| GetInstanceData(cDbPropertyMask) |
Gets extracted instance property values, with masking/sorting/grouping.
(Inherited from cDbClassInstanceCache) |
| GetInstanceData(IEnumerablecDbClassInstance, cDbPropertyMask, Boolean) | (Inherited from cDbClassInstanceCache) |
| GetInstanceData(String, Array, cDbPropertyMask, cDbClassInstanceCachecGetFlags) |
Gets extracted instance property values, with masking/sorting/grouping.
(Inherited from cDbClassInstanceCache) |
| GetInstanceData(String, Array, cDbPropertyMask, cDbClassInstanceCachecGetFlags, Int32) |
Gets extracted instance property values, with masking/sorting/grouping.
(Inherited from cDbClassInstanceCache) |
| GetInstanceDataWithSecurityChecking |
Gets extracted instance property values, with masking/sorting/grouping with security checking. This call should be used only when an application is
serving multiple different users and has set the cDriverSkeleton.ActiveUser to an IUserProvider object that provides the information on the user
making the call.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet |
Gets an instance set that includes all the instances.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(cDbPropertyMask) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(cDbPropertyMask, cDbClassInstanceCachecGetFlags) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(cDbPropertyMask, Boolean) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(cDbPropertyMask, Int32) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String, Object) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(Boolean, String, Object) | (Inherited from cDbClassInstanceCache) |
| GetInstanceSet(cDbClassInstanceCachecGetFlags, String, Object) | (Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String, Array, cDbPropertyMask) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String, Array, cDbPropertyMask, cDbClassInstanceCachecGetFlags) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String, Array, cDbPropertyMask, Int32, cDbClassInstanceCachecGetFlags) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstanceSet(String, Array, cDbPropertyMask, Int32, cDbClassInstance, cDbPropertyMask, cDbClassInstanceCachecGetFlags) |
Gets an instance set according the given masking.
(Inherited from cDbClassInstanceCache) |
| GetInstancesWithSecurityChecking |
Get instance set based on give masking and do security checking on the results. This call should be used only when an application is serving
multiple different users and has set the cDriverSkeleton.ActiveUser to an IUserProvider object that provides the information on the user
making the call.
(Inherited from cDbClassInstanceCache) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeClassWithinDriverCode | |
| Invalidate |
Invalidates cache contents forcing reloading of everything from database.
(Inherited from cDbClassInstanceCache) |
| ReferrersTo(String, cDbClassInstance) |
Gets list of instances having given property name the given value.
(Inherited from cDbClassInstanceCache) |
| ReferrersTo(String, cDbClassInstance, cDbPropertyMask) | (Inherited from cDbClassInstanceCache) |
| RemoveFromCache |
Removes the instance from the cache, NOT from the database.
(Inherited from cDbClassInstanceCache) |
| ReplacePermissionsOnChildObjects | (Inherited from cDbClassInstanceCache) |
| Request(String) |
Used for speeding things up - requesting multiple classes before accessing them allows the driver
to merge the queries.
(Inherited from cDbClassInstanceCache) |
| RequestNames |
Used for speeding things up - requesting multiple classes before accessing them allows the driver
to merge the queries.
(Inherited from cDbClassInstanceCache) |
| ToString | (Inherited from cDbClassInstanceCache) |
Events| Name | Description | |
|---|---|---|
 | Changed |
Adds an event handler to listen the Changed event on the cDbClassInstanceCache. This event
will be fired when ever an instance in cache has changed or deleted or an instance is inserted into cache.
Use of GetInstanceSet to other classes within the Changed event's handler should be double checked against
deadlocks.
(Inherited from cDbClassInstanceCache) |
| ChangedUnlocked | (Inherited from cDbClassInstanceCache) |
Fields| Name | Description | |
|---|---|---|
 | Class |
Gets cDbClass owning this cache.
(Inherited from cDbClassInstanceCache) |
| DisableMissingOptimization | (Inherited from cDbClassInstanceCache) |
| ForceCacheUpdateOnCommit |
Sets, whether the cache should be updated by local commits even if server does not confirm the update (not on error return though).
This can be useful with classes on which commits result to an asynchronous operation being queued, like with cpmPlus history CurrentValues.
WARNING: Understand, that setting this true causes cache being not in sync with the actual data, which could result in incorrect
information being displayed and there is no way to verify anymore whether the commit has actually taken effect or not.
(Inherited from cDbClassInstanceCache) |
See Also